diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
index 87909cedb..05a3793c9 100644
--- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json
+++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
@@ -29521,307 +29521,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",
@@ -65937,307 +65636,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)",
@@ -122370,19 +121768,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -122468,8 +121853,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -122483,115 +121866,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "$ref": "#/components/schemas/simple-user"
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "
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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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",
@@ -299575,8 +298849,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",
@@ -299628,8 +298900,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",
@@ -299680,8 +298950,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",
@@ -299707,149 +298975,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": {
@@ -320892,15 +320017,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
index cedfc2d29..54573bf1c 100644
--- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
+++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
@@ -21325,217 +21325,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
@@ -47815,227 +47604,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)
@@ -88778,15 +88346,6 @@ components:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -88849,8 +88408,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -88862,85 +88419,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:
- anyOf:
- - type: 'null'
- - "$ref": "#/components/schemas/simple-user"
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - 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
@@ -221553,8 +221031,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
@@ -221601,8 +221077,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
@@ -221649,8 +221123,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
@@ -221673,135 +221145,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:
@@ -239996,13 +239339,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
index 87909cedb..05a3793c9 100644
--- a/descriptions-next/api.github.com/api.github.com.json
+++ b/descriptions-next/api.github.com/api.github.com.json
@@ -29521,307 +29521,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",
@@ -65937,307 +65636,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)",
@@ -122370,19 +121768,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -122468,8 +121853,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -122483,115 +121866,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "$ref": "#/components/schemas/simple-user"
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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",
@@ -299575,8 +298849,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",
@@ -299628,8 +298900,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",
@@ -299680,8 +298950,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",
@@ -299707,149 +298975,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": {
@@ -320892,15 +320017,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml
index cedfc2d29..54573bf1c 100644
--- a/descriptions-next/api.github.com/api.github.com.yaml
+++ b/descriptions-next/api.github.com/api.github.com.yaml
@@ -21325,217 +21325,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
@@ -47815,227 +47604,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)
@@ -88778,15 +88346,6 @@ components:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -88849,8 +88408,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -88862,85 +88419,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:
- anyOf:
- - type: 'null'
- - "$ref": "#/components/schemas/simple-user"
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - 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
@@ -221553,8 +221031,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
@@ -221601,8 +221077,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
@@ -221649,8 +221123,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
@@ -221673,135 +221145,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:
@@ -239996,13 +239339,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
index 5226d58a1..e72800b67 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
@@ -229832,19 +229832,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -229976,8 +229963,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230019,8 +230004,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",
@@ -230340,19 +230323,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -230484,8 +230454,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230525,8 +230493,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",
@@ -230812,19 +230778,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -230956,8 +230909,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230997,8 +230948,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",
@@ -231308,19 +231257,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -231452,8 +231388,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -231493,8 +231427,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",
@@ -231585,17 +231517,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": [
{
@@ -231617,26 +231549,376 @@
}
},
{
- "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/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",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "failed_reason": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "inviter": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
+ ]
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "team_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ ]
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "examples": [
+ "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ ]
+ },
+ "invitation_source": {
+ "type": "string",
+ "examples": [
+ "\"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": "integer"
+ "type": "string"
}
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
+ "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": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -231666,322 +231948,170 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
+ "name": {
+ "type": [
+ "string",
+ "null"
]
},
- "body": {
- "description": "The main text of the comment.",
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "octocat"
]
},
- "body_html": {
- "type": "string",
+ "id": {
+ "type": "integer",
+ "format": "int64",
"examples": [
- "Do you like apples?
"
+ 1
]
},
- "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.",
+ "node_id": {
"type": "string",
"examples": [
- "0307116bbf7ced493b8d8a346c650b71"
+ "MDQ6VXNlcjE="
]
},
- "created_at": {
+ "avatar_url": {
"type": "string",
- "format": "date-time",
+ "format": "uri",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://github.com/images/error/octocat_happy.gif"
]
},
- "last_edited_at": {
+ "gravatar_id": {
"type": [
"string",
"null"
],
- "format": "date-time"
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "https://api.github.com/users/octocat"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/octocat"
]
},
- "node_id": {
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "https://api.github.com/users/octocat/followers"
]
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
+ "following_url": {
+ "type": "string",
"examples": [
- 42
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
]
},
- "url": {
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "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",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
},
"required": [
- "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"
]
}
@@ -231990,49 +232120,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
}
]
}
@@ -232053,19 +232158,126 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "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",
+ "type": "string",
+ "examples": [
+ "member"
+ ]
+ },
+ "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"
}
},
- "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.",
+ "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/create-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#create-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -232087,35 +232299,38 @@
}
},
{
- "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"
}
}
],
"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"
}
}
}
@@ -232123,403 +232338,83 @@
}
},
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
+ "url": {
"type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "format": "uri"
},
- "last_edited_at": {
- "type": [
- "string",
- "null"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
+ "default": "member",
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "member"
]
},
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- }
- },
- "/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.",
+ },
+ "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/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\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/get-discussion-comment-in-org",
+ "operationId": "teams/remove-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#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -232541,978 +232436,78 @@
}
},
{
- "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": {
+ "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/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": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
- }
- }
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "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"
- }
- }
- ],
- "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": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
+ "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
}
}
],
@@ -233524,45 +232519,36 @@
"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",
- "null"
+ "format": "int64",
+ "examples": [
+ 1296269
]
},
- "email": {
- "type": [
- "string",
- "null"
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
]
},
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": [
- "string",
- "null"
+ "name": {
+ "type": "string",
+ "examples": [
+ "Hello-World"
]
},
- "failed_reason": {
- "type": [
- "string",
- "null"
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
]
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -233730,974 +232716,39 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "https://github.com/octocat/Hello-World"
]
},
- "invitation_teams_url": {
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "https://api.github.com/repos/octocat/Hello-World"
]
},
- "invitation_source": {
+ "archive_url": {
"type": "string",
"examples": [
- "\"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": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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/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\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/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/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/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": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1296269
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Hello-World"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "This your first repo!"
- ]
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/repos/octocat/Hello-World"
- ]
- },
- "archive_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
]
},
"assignees_url": {
@@ -623941,2801 +621992,715 @@
"closed"
]
},
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "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",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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/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": {
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "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": {
@@ -626744,20 +622709,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": [
{
@@ -626768,20 +622733,112 @@
"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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -626790,22 +622847,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": [
{
@@ -626817,15 +622874,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.",
@@ -626867,8 +622915,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": {
@@ -627047,16 +623095,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627070,7 +623118,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627080,45 +623128,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -627178,10 +623247,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -627211,19 +623283,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,
@@ -627256,20 +623331,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": [
{
@@ -627280,15 +623355,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -627298,19 +623364,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."
}
}
}
@@ -627323,8 +623400,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": {
@@ -627503,16 +623580,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627526,7 +623603,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627536,45 +623613,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -627634,10 +623732,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -627665,19 +623766,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,
@@ -627702,22 +623806,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": [
{
@@ -627737,15 +623841,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -627754,8 +623849,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": {
@@ -627934,16 +624029,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627957,7 +624052,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627967,45 +624062,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -628065,10 +624181,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -628096,19 +624215,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,
@@ -628132,20 +624254,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": [
{
@@ -628165,37 +624287,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"
}
}
}
@@ -628208,8 +624322,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": {
@@ -628388,16 +624502,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -628411,7 +624525,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -628421,45 +624535,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -628519,10 +624654,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -628550,19 +624688,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,
@@ -628586,20 +624727,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": [
{
@@ -628619,15 +624760,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -628641,7 +624773,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
index 121df3240..d25fea90c 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
@@ -1071,7 +1071,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &621
+ - &618
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -9169,7 +9169,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
- - &460
+ - &457
name: has
in: query
description: |-
@@ -9289,7 +9289,7 @@ paths:
- direct
- transitive
-
- security_advisory: &461
+ security_advisory: &458
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9557,7 +9557,7 @@ paths:
and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- auto_dismissed_at: &462
+ auto_dismissed_at: &459
type:
- string
- 'null'
@@ -9565,7 +9565,7 @@ paths:
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissal_request: &463
+ dismissal_request: &460
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10956,7 +10956,7 @@ paths:
properties:
action:
type: string
- discussion: &716
+ discussion: &711
title: Discussion
description: A Discussion in a repository.
type: object
@@ -11742,7 +11742,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &633
+ sub_issues_summary: &630
title: Sub-issues Summary
type: object
properties:
@@ -11763,7 +11763,7 @@ paths:
- string
- 'null'
format: uri
- issue_dependencies_summary: &634
+ issue_dependencies_summary: &631
title: Issue Dependencies Summary
type: object
properties:
@@ -11782,7 +11782,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &635
+ items: &632
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11895,7 +11895,7 @@ paths:
action:
type: string
issue: *70
- comment: &510
+ comment: &507
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12618,7 +12618,7 @@ paths:
type: string
release:
allOf:
- - &566
+ - &563
title: Release
description: A release.
type: object
@@ -12700,7 +12700,7 @@ paths:
author: *4
assets:
type: array
- items: &567
+ items: &564
title: Release Asset
description: Data related to a release.
type: object
@@ -13303,7 +13303,7 @@ paths:
url:
type: string
format: uri
- user: &645
+ user: &640
title: Public User
description: Public User
type: object
@@ -16660,14 +16660,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &314
+ - &311
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &315
+ - &312
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16729,7 +16729,7 @@ paths:
'404': *6
'403': *27
'304': *35
- '301': &318
+ '301': &315
description: Moved permanently
content:
application/json:
@@ -16751,7 +16751,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &540
+ - &537
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16759,7 +16759,7 @@ paths:
schema:
type: boolean
default: false
- - &541
+ - &538
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16769,7 +16769,7 @@ paths:
type: boolean
default: false
- *76
- - &542
+ - &539
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:
@@ -17305,7 +17305,7 @@ paths:
- url
- subscription_url
examples:
- default: &543
+ default: &540
value:
- id: '1'
repository:
@@ -18332,7 +18332,7 @@ paths:
- property_name
- value
examples:
- default: &549
+ default: &546
value:
- property_name: environment
value: production
@@ -18382,7 +18382,7 @@ paths:
required:
- properties
examples:
- default: &550
+ default: &547
value:
properties:
- property_name: environment
@@ -18956,7 +18956,7 @@ paths:
required: false
schema:
type: string
- - &693
+ - &688
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -19102,7 +19102,7 @@ paths:
parameters:
- *65
- *107
- - &694
+ - &689
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
@@ -19214,7 +19214,7 @@ paths:
- *107
- *109
- *108
- - &695
+ - &690
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -19222,7 +19222,7 @@ paths:
schema:
type: string
- *110
- - &696
+ - &691
name: sku
description: The SKU to query for usage.
in: query
@@ -20201,7 +20201,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &325
+ items: &322
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -21439,7 +21439,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &331
+ selected_actions_url: &328
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`
@@ -21522,7 +21522,7 @@ paths:
description: Response
content:
application/json:
- schema: &335
+ schema: &332
type: object
properties:
days:
@@ -21564,7 +21564,7 @@ paths:
required: true
content:
application/json:
- schema: &336
+ schema: &333
type: object
properties:
days:
@@ -21621,7 +21621,7 @@ paths:
required:
- approval_policy
examples:
- default: &337
+ default: &334
value:
approval_policy: first_time_contributors
'404': *6
@@ -21680,7 +21680,7 @@ paths:
description: Response
content:
application/json:
- schema: &338
+ schema: &335
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21734,7 +21734,7 @@ paths:
required: true
content:
application/json:
- schema: &339
+ schema: &336
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -22369,7 +22369,7 @@ paths:
description: Response
content:
application/json:
- schema: &340
+ schema: &337
type: object
properties:
default_workflow_permissions: &137
@@ -22420,7 +22420,7 @@ paths:
required: false
content:
application/json:
- schema: &341
+ schema: &338
type: object
properties:
default_workflow_permissions: *137
@@ -22913,7 +22913,7 @@ paths:
type: array
items: *144
examples:
- default: &648
+ default: &643
value:
total_count: 1
repositories:
@@ -23560,7 +23560,7 @@ paths:
application/json:
schema:
type: array
- items: &342
+ items: &339
title: Runner Application
description: Runner Application
type: object
@@ -23585,7 +23585,7 @@ paths:
- download_url
- filename
examples:
- default: &343
+ default: &340
value:
- os: osx
architecture: x64
@@ -23671,7 +23671,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &344
+ '201': &341
description: Response
content:
application/json:
@@ -23786,7 +23786,7 @@ paths:
- token
- expires_at
examples:
- default: &345
+ default: &342
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23825,7 +23825,7 @@ paths:
application/json:
schema: *148
examples:
- default: &346
+ default: &343
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23859,7 +23859,7 @@ paths:
application/json:
schema: *146
examples:
- default: &347
+ default: &344
value:
id: 23
name: MBP
@@ -24085,7 +24085,7 @@ paths:
- *65
- *145
responses:
- '200': &348
+ '200': &345
description: Response
content:
application/json:
@@ -24142,7 +24142,7 @@ paths:
parameters:
- *65
- *145
- - &349
+ - &346
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -24274,7 +24274,7 @@ paths:
description: Response
content:
application/json:
- schema: &361
+ schema: &358
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -24309,7 +24309,7 @@ paths:
- key_id
- key
examples:
- default: &362
+ default: &359
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -24722,7 +24722,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *65
- - &330
+ - &327
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)."
@@ -25883,12 +25883,12 @@ paths:
required:
- subject_digests
examples:
- default: &675
+ default: &670
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &676
+ withPredicateType: &671
value:
subject_digests:
- sha256:abc123
@@ -25947,7 +25947,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &677
+ default: &672
value:
attestations_subject_digests:
- sha256:abc:
@@ -26296,7 +26296,7 @@ paths:
initiator:
type: string
examples:
- default: &375
+ default: &372
value:
attestations:
- bundle:
@@ -27252,7 +27252,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *65
- - &399
+ - &396
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`,
@@ -27262,7 +27262,7 @@ paths:
schema: &169
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &400
+ - &397
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
@@ -27286,7 +27286,7 @@ paths:
be returned.
in: query
required: false
- schema: &402
+ schema: &399
type: string
description: State of a code scanning alert.
enum:
@@ -27309,7 +27309,7 @@ paths:
be returned.
in: query
required: false
- schema: &403
+ schema: &400
type: string
description: Severity of a code scanning alert.
enum:
@@ -27343,7 +27343,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: &404
+ instances_url: &401
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -27365,7 +27365,7 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: &405
+ dismissed_reason: &402
type:
- string
- 'null'
@@ -27376,14 +27376,14 @@ paths:
- won't fix
- used in tests
-
- dismissed_comment: &406
+ dismissed_comment: &403
type:
- string
- 'null'
description: The dismissal comment associated with the dismissal
of the alert.
maxLength: 280
- rule: &407
+ rule: &404
type: object
properties:
id:
@@ -27444,7 +27444,7 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: &408
+ tool: &405
type: object
properties:
name: *169
@@ -27455,26 +27455,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *170
- most_recent_instance: &409
+ most_recent_instance: &406
type: object
properties:
- ref: &401
+ ref: &398
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &419
+ analysis_key: &416
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: &420
+ environment: &417
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: &421
+ category: &418
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -27488,7 +27488,7 @@ paths:
properties:
text:
type: string
- location: &422
+ location: &419
type: object
description: Describe a region within a file for the alert.
properties:
@@ -27509,7 +27509,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: &423
+ items: &420
type:
- string
- 'null'
@@ -28802,7 +28802,7 @@ paths:
machine:
anyOf:
- type: 'null'
- - &435
+ - &432
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
@@ -29754,7 +29754,7 @@ paths:
- updated_at
- visibility
examples:
- default: &436
+ default: &433
value:
total_count: 2
secrets:
@@ -29792,7 +29792,7 @@ paths:
description: Response
content:
application/json:
- schema: &437
+ schema: &434
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -29827,7 +29827,7 @@ paths:
- key_id
- key
examples:
- default: &438
+ default: &435
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -29859,7 +29859,7 @@ paths:
application/json:
schema: *179
examples:
- default: &440
+ default: &437
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -31482,7 +31482,7 @@ paths:
description: Response
content:
application/json:
- schema: &466
+ schema: &463
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -31501,7 +31501,7 @@ paths:
- key_id
- key
examples:
- default: &467
+ default: &464
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -33329,7 +33329,7 @@ paths:
application/json:
schema: *20
examples:
- default: &505
+ default: &502
value:
id: 1
account:
@@ -33557,7 +33557,7 @@ paths:
required: true
content:
application/json:
- schema: &506
+ schema: &503
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -34417,7 +34417,7 @@ paths:
application/json:
schema: *221
examples:
- default: &434
+ default: &431
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -35679,7 +35679,7 @@ paths:
parameters:
- *65
- *228
- - &660
+ - &655
name: repo_name
description: repo_name parameter
in: path
@@ -36738,7 +36738,7 @@ paths:
- nuget
- container
- *65
- - &661
+ - &656
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -36779,7 +36779,7 @@ paths:
default: *234
'403': *27
'401': *23
- '400': &663
+ '400': &658
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -38605,7 +38605,7 @@ paths:
latest_status_update:
anyOf:
- type: 'null'
- - &744
+ - &739
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -38879,7 +38879,7 @@ paths:
content:
oneOf:
- *70
- - &449
+ - &446
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -39124,7 +39124,7 @@ paths:
- review_comment
- self
author_association: *71
- auto_merge: &552
+ auto_merge: &549
title: Auto merge
description: The status of auto merging a pull request.
type:
@@ -39506,7 +39506,7 @@ paths:
- updated_at
- project_url
examples:
- default: &680
+ default: &675
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -39683,7 +39683,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &681
+ items: &676
type: object
properties:
name:
@@ -39719,7 +39719,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &682
+ iteration_configuration: &677
type: object
description: The configuration for iteration fields.
properties:
@@ -39768,7 +39768,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &683
+ single_select_field: &678
summary: Create a single select field
value:
name: Priority
@@ -39795,7 +39795,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &684
+ iteration_field: &679
summary: Create an iteration field
value:
name: Sprint
@@ -39821,7 +39821,7 @@ paths:
application/json:
schema: *254
examples:
- text_field: &685
+ text_field: &680
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -39830,7 +39830,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: &686
+ number_field: &681
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -39839,7 +39839,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: &687
+ date_field: &682
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -39848,7 +39848,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: &688
+ single_select_field: &683
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -39882,7 +39882,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &689
+ iteration_field: &684
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -39928,7 +39928,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *251
- - &690
+ - &685
name: field_id
description: The unique identifier of the field.
in: path
@@ -39943,7 +39943,7 @@ paths:
application/json:
schema: *254
examples:
- default: &691
+ default: &686
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -41076,7 +41076,7 @@ paths:
parameters:
- *251
- *65
- - &692
+ - &687
name: view_number
description: The number that identifies the project view.
in: path
@@ -42011,7 +42011,7 @@ paths:
description: Response
content:
application/json:
- schema: &317
+ schema: &314
title: Full Repository
description: Full Repository
type: object
@@ -42476,7 +42476,7 @@ paths:
description: Whether anonymous git access is allowed.
default: true
type: boolean
- code_of_conduct: &454
+ code_of_conduct: &451
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
@@ -42590,7 +42590,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &319
+ default: &316
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -43111,7 +43111,7 @@ paths:
- *65
- *17
- *19
- - &574
+ - &571
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -43397,7 +43397,7 @@ paths:
- object
rules:
type: array
- items: &575
+ items: &572
title: Repository Rule
type: object
description: A repository rule.
@@ -43459,7 +43459,7 @@ paths:
type: string
enum:
- required_linear_history
- - &573
+ - &570
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -44355,7 +44355,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *65
- - &576
+ - &573
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
@@ -44370,7 +44370,7 @@ paths:
in: query
schema:
type: string
- - &577
+ - &574
name: time_period
description: |-
The time period to filter by.
@@ -44386,14 +44386,14 @@ paths:
- week
- month
default: day
- - &578
+ - &575
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
- - &579
+ - &576
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -44413,7 +44413,7 @@ paths:
description: Response
content:
application/json:
- schema: &580
+ schema: &577
title: Rule Suites
description: Response
type: array
@@ -44469,7 +44469,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &581
+ default: &578
value:
- id: 21
actor_id: 12
@@ -44513,7 +44513,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *65
- - &582
+ - &579
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -44529,7 +44529,7 @@ paths:
description: Response
content:
application/json:
- schema: &583
+ schema: &580
title: Rule Suite
description: Response
type: object
@@ -44636,7 +44636,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &584
+ default: &581
value:
id: 21
actor_id: 12
@@ -44882,7 +44882,7 @@ paths:
type: string
format: date-time
examples:
- default: &586
+ default: &583
value:
- version_id: 3
actor:
@@ -44935,7 +44935,7 @@ paths:
description: Response
content:
application/json:
- schema: &587
+ schema: &584
allOf:
- *295
- type: object
@@ -45007,7 +45007,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *65
- - &588
+ - &585
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -45018,7 +45018,7 @@ paths:
enum:
- open
- resolved
- - &589
+ - &586
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -45028,7 +45028,7 @@ paths:
required: false
schema:
type: string
- - &590
+ - &587
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -45037,7 +45037,7 @@ paths:
required: false
schema:
type: string
- - &591
+ - &588
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -45056,7 +45056,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &592
+ - &589
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.
@@ -45071,7 +45071,7 @@ paths:
- *50
- *19
- *17
- - &593
+ - &590
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
@@ -45081,7 +45081,7 @@ paths:
required: false
schema:
type: string
- - &594
+ - &591
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
@@ -45091,7 +45091,7 @@ paths:
required: false
schema:
type: string
- - &595
+ - &592
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -45100,7 +45100,7 @@ paths:
required: false
schema:
type: string
- - &596
+ - &593
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -45109,7 +45109,7 @@ paths:
schema:
type: boolean
default: false
- - &597
+ - &594
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -45118,7 +45118,7 @@ paths:
schema:
type: boolean
default: false
- - &598
+ - &595
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -45150,14 +45150,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &599
+ state: &596
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: &600
+ resolution: &597
type:
- string
- 'null'
@@ -45264,14 +45264,14 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - &601
+ - &598
description: 'Details on the location where the token was
initially detected. This can be a commit, wiki commit, issue,
discussion, pull request.
'
oneOf:
- - &603
+ - &600
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -45328,7 +45328,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &604
+ - &601
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.
@@ -45389,7 +45389,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &605
+ - &602
description: Represents an 'issue_title' secret scanning
location type. This location type shows that a secret
was detected in the title of an issue.
@@ -45404,7 +45404,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &606
+ - &603
description: Represents an 'issue_body' secret scanning
location type. This location type shows that a secret
was detected in the body of an issue.
@@ -45419,7 +45419,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &607
+ - &604
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on an issue.
@@ -45434,7 +45434,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &608
+ - &605
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret
was detected in the title of a discussion.
@@ -45449,7 +45449,7 @@ paths:
- https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &609
+ - &606
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret
was detected in the body of a discussion.
@@ -45464,7 +45464,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &610
+ - &607
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on a discussion.
@@ -45479,7 +45479,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &611
+ - &608
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.
@@ -45494,7 +45494,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &612
+ - &609
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.
@@ -45509,7 +45509,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &613
+ - &610
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.
@@ -45524,7 +45524,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &614
+ - &611
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.
@@ -45539,7 +45539,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &615
+ - &612
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
@@ -46039,7 +46039,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &616
description: A repository security advisory.
type: object
properties:
@@ -46358,7 +46358,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &620
+ default: &617
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -48281,15 +48281,6 @@ paths:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -48352,8 +48343,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -48366,7 +48355,7 @@ paths:
- updated_at
- url
examples:
- default: &637
+ default: &634
value:
- author:
login: octocat
@@ -48391,8 +48380,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
@@ -48502,8 +48489,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
@@ -48614,7 +48599,7 @@ paths:
application/json:
schema: *307
examples:
- default: &638
+ default: &635
value:
author:
login: octocat
@@ -48639,8 +48624,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
@@ -48695,418 +48678,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:
- - *65
- - *66
- - *309
- - *50
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &310
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- anyOf:
- - type: 'null'
- - *4
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *72
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &639
- 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: *56
- 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:
- - *65
- - *66
- - *309
- 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: *310
- examples:
- default: &311
- 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:
- - *65
- - *66
- - *309
- - &312
- 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: *310
- examples:
- default: *311
- 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:
- - *65
- - *66
- - *309
- - *312
- 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: *310
- examples:
- default: &640
- 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:
- - *65
- - *66
- - *309
- - *312
- 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
@@ -49219,7 +48790,7 @@ paths:
description: Response
content:
application/json:
- schema: &313
+ schema: &310
title: Team Membership
description: Team Membership
type: object
@@ -49247,7 +48818,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &641
+ response-if-user-is-a-team-maintainer: &636
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -49310,9 +48881,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-users-membership-with-team-is-now-pending: &642
+ response-if-users-membership-with-team-is-now-pending: &637
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -49419,14 +48990,14 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &643
+ schema: &638
title: Team Repository
description: A team's access to a repository.
type: object
@@ -50069,8 +49640,8 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -50117,8 +49688,8 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -50155,7 +49726,7 @@ paths:
type: array
items: *180
examples:
- response-if-child-teams-exist: &644
+ response-if-child-teams-exist: &639
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -50309,7 +49880,7 @@ paths:
resources:
type: object
properties:
- core: &316
+ core: &313
title: Rate Limit
type: object
properties:
@@ -50326,21 +49897,21 @@ paths:
- remaining
- reset
- used
- graphql: *316
- search: *316
- code_search: *316
- source_import: *316
- integration_manifest: *316
- code_scanning_upload: *316
- actions_runner_registration: *316
- scim: *316
- dependency_snapshots: *316
- dependency_sbom: *316
- code_scanning_autofix: *316
+ graphql: *313
+ search: *313
+ code_search: *313
+ source_import: *313
+ integration_manifest: *313
+ code_scanning_upload: *313
+ actions_runner_registration: *313
+ scim: *313
+ dependency_snapshots: *313
+ dependency_sbom: *313
+ code_scanning_autofix: *313
required:
- core
- search
- rate: *316
+ rate: *313
required:
- rate
- resources
@@ -50445,14 +50016,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
default-response:
summary: Default response
@@ -50953,7 +50524,7 @@ paths:
status: disabled
'403': *27
'404': *6
- '301': *318
+ '301': *315
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50971,8 +50542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -51220,10 +50791,10 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
- '307': &320
+ default: *316
+ '307': &317
description: Temporary Redirect
content:
application/json:
@@ -51252,8 +50823,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -51275,7 +50846,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *320
+ '307': *317
'404': *6
'409': *49
x-github:
@@ -51299,11 +50870,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- - &353
+ - &350
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -51326,7 +50897,7 @@ paths:
type: integer
artifacts:
type: array
- items: &321
+ items: &318
title: Artifact
description: An artifact
type: object
@@ -51421,7 +50992,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &354
+ default: &351
value:
total_count: 2
artifacts:
@@ -51482,9 +51053,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *314
- - *315
- - &322
+ - *311
+ - *312
+ - &319
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -51496,7 +51067,7 @@ paths:
description: Response
content:
application/json:
- schema: *321
+ schema: *318
examples:
default:
value:
@@ -51534,9 +51105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *314
- - *315
- - *322
+ - *311
+ - *312
+ - *319
responses:
'204':
description: Response
@@ -51560,9 +51131,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *314
- - *315
- - *322
+ - *311
+ - *312
+ - *319
- name: archive_format
in: path
required: true
@@ -51576,7 +51147,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': &509
+ '410': &506
description: Gone
content:
application/json:
@@ -51601,14 +51172,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &323
+ schema: &320
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -51642,13 +51213,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *323
+ schema: *320
examples:
selected_actions: *40
responses:
@@ -51677,14 +51248,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &324
+ schema: &321
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -51718,13 +51289,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *324
+ schema: *321
examples:
selected_actions: *42
responses:
@@ -51755,14 +51326,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *325
+ schema: *322
examples:
default:
value:
@@ -51788,11 +51359,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- - &326
+ - &323
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
@@ -51826,7 +51397,7 @@ paths:
description: Response
content:
application/json:
- schema: &327
+ schema: &324
title: Repository actions caches
description: Repository actions caches
type: object
@@ -51876,7 +51447,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &328
+ default: &325
value:
total_count: 1
actions_caches:
@@ -51908,23 +51479,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:
- - *314
- - *315
+ - *311
+ - *312
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *326
+ - *323
responses:
'200':
description: Response
content:
application/json:
- schema: *327
+ schema: *324
examples:
- default: *328
+ default: *325
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51944,8 +51515,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:
- - *314
- - *315
+ - *311
+ - *312
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -51976,9 +51547,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *314
- - *315
- - &329
+ - *311
+ - *312
+ - &326
name: job_id
description: The unique identifier of the job.
in: path
@@ -51990,7 +51561,7 @@ paths:
description: Response
content:
application/json:
- schema: &357
+ schema: &354
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -52337,9 +51908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *314
- - *315
- - *329
+ - *311
+ - *312
+ - *326
responses:
'302':
description: Response
@@ -52367,9 +51938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *314
- - *315
- - *329
+ - *311
+ - *312
+ - *326
requestBody:
required: false
content:
@@ -52415,8 +51986,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Status response
@@ -52466,8 +52037,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -52530,8 +52101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -52549,7 +52120,7 @@ paths:
type: integer
secrets:
type: array
- items: &359
+ items: &356
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -52570,7 +52141,7 @@ paths:
- created_at
- updated_at
examples:
- default: &360
+ default: &357
value:
total_count: 2
secrets:
@@ -52603,9 +52174,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *314
- - *315
- - *330
+ - *311
+ - *312
+ - *327
- *19
responses:
'200':
@@ -52622,7 +52193,7 @@ paths:
type: integer
variables:
type: array
- items: &363
+ items: &360
title: Actions Variable
type: object
properties:
@@ -52656,7 +52227,7 @@ paths:
- created_at
- updated_at
examples:
- default: &364
+ default: &361
value:
total_count: 2
variables:
@@ -52689,8 +52260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -52699,11 +52270,11 @@ paths:
schema:
type: object
properties:
- enabled: &332
+ enabled: &329
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *129
- selected_actions_url: *331
+ selected_actions_url: *328
sha_pinning_required: *130
required:
- enabled
@@ -52732,8 +52303,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -52744,7 +52315,7 @@ paths:
schema:
type: object
properties:
- enabled: *332
+ enabled: *329
allowed_actions: *129
sha_pinning_required: *130
required:
@@ -52776,14 +52347,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &333
+ schema: &330
type: object
properties:
access_level:
@@ -52800,7 +52371,7 @@ paths:
required:
- access_level
examples:
- default: &334
+ default: &331
value:
access_level: organization
x-github:
@@ -52824,15 +52395,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *334
+ default: *331
responses:
'204':
description: Response
@@ -52856,14 +52427,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *335
+ schema: *332
examples:
default:
value:
@@ -52887,8 +52458,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Empty response for successful settings update
@@ -52898,7 +52469,7 @@ paths:
required: true
content:
application/json:
- schema: *336
+ schema: *333
examples:
default:
summary: Set retention days
@@ -52922,8 +52493,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -52931,7 +52502,7 @@ paths:
application/json:
schema: *131
examples:
- default: *337
+ default: *334
'404': *6
x-github:
enabledForGitHubApps: true
@@ -52950,8 +52521,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -52985,14 +52556,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
default: *132
'403': *27
@@ -53014,13 +52585,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *339
+ schema: *336
examples:
default: *132
responses:
@@ -53046,8 +52617,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -53074,8 +52645,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -53107,14 +52678,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
default: *139
x-github:
@@ -53137,8 +52708,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Success response
@@ -53149,7 +52720,7 @@ paths:
required: true
content:
application/json:
- schema: *341
+ schema: *338
examples:
default: *139
x-github:
@@ -53178,8 +52749,8 @@ paths:
in: query
schema:
type: string
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -53223,8 +52794,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -53232,9 +52803,9 @@ paths:
application/json:
schema:
type: array
- items: *342
+ items: *339
examples:
- default: *343
+ default: *340
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53256,8 +52827,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -53300,7 +52871,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *344
+ '201': *341
'404': *6
'422': *7
'409': *49
@@ -53331,8 +52902,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -53340,7 +52911,7 @@ paths:
application/json:
schema: *148
examples:
- default: *345
+ default: *342
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53368,8 +52939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -53377,7 +52948,7 @@ paths:
application/json:
schema: *148
examples:
- default: *346
+ default: *343
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53399,8 +52970,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'200':
@@ -53409,7 +52980,7 @@ paths:
application/json:
schema: *146
examples:
- default: *347
+ default: *344
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53430,8 +53001,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'204':
@@ -53458,8 +53029,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'200': *150
@@ -53484,8 +53055,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
requestBody:
required: true
@@ -53534,8 +53105,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
requestBody:
required: true
@@ -53585,11 +53156,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
- '200': *348
+ '200': *345
'404': *6
x-github:
githubCloudOnly: false
@@ -53616,10 +53187,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
- - *349
+ - *346
responses:
'200': *150
'404': *6
@@ -53647,9 +53218,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *314
- - *315
- - &367
+ - *311
+ - *312
+ - &364
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.
@@ -53657,7 +53228,7 @@ paths:
required: false
schema:
type: string
- - &368
+ - &365
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -53665,7 +53236,7 @@ paths:
required: false
schema:
type: string
- - &369
+ - &366
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -53674,7 +53245,7 @@ paths:
required: false
schema:
type: string
- - &370
+ - &367
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
@@ -53701,7 +53272,7 @@ paths:
- pending
- *17
- *19
- - &371
+ - &368
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)."
@@ -53710,7 +53281,7 @@ paths:
schema:
type: string
format: date-time
- - &350
+ - &347
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -53719,13 +53290,13 @@ paths:
schema:
type: boolean
default: false
- - &372
+ - &369
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &373
+ - &370
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -53748,7 +53319,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &351
+ items: &348
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -53926,7 +53497,7 @@ paths:
head_commit:
anyOf:
- type: 'null'
- - &395
+ - &392
title: Simple Commit
description: A commit.
type: object
@@ -54041,7 +53612,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &374
+ default: &371
value:
total_count: 1
workflow_runs:
@@ -54277,24 +53848,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *314
- - *315
- - &352
+ - *311
+ - *312
+ - &349
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *350
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
- default: &355
+ default: &352
value:
id: 30433642
name: Build
@@ -54535,9 +54106,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'204':
description: Response
@@ -54560,9 +54131,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -54690,9 +54261,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:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'201':
description: Response
@@ -54725,12 +54296,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
- *17
- *19
- - *353
+ - *350
responses:
'200':
description: Response
@@ -54746,9 +54317,9 @@ paths:
type: integer
artifacts:
type: array
- items: *321
+ items: *318
examples:
- default: *354
+ default: *351
headers:
Link: *56
x-github:
@@ -54772,25 +54343,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *314
- - *315
- - *352
- - &356
+ - *311
+ - *312
+ - *349
+ - &353
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *350
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
- default: *355
+ default: *352
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -54813,10 +54384,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *314
- - *315
- - *352
- - *356
+ - *311
+ - *312
+ - *349
+ - *353
- *17
- *19
responses:
@@ -54834,9 +54405,9 @@ paths:
type: integer
jobs:
type: array
- items: *357
+ items: *354
examples:
- default: &358
+ default: &355
value:
total_count: 1
jobs:
@@ -54949,10 +54520,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *314
- - *315
- - *352
- - *356
+ - *311
+ - *312
+ - *349
+ - *353
responses:
'302':
description: Response
@@ -54980,9 +54551,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'202':
description: Response
@@ -55015,9 +54586,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:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: true
content:
@@ -55084,9 +54655,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'202':
description: Response
@@ -55119,9 +54690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
- 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
@@ -55151,9 +54722,9 @@ paths:
type: integer
jobs:
type: array
- items: *357
+ items: *354
examples:
- default: *358
+ default: *355
headers:
Link: *56
x-github:
@@ -55178,9 +54749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'302':
description: Response
@@ -55207,9 +54778,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'204':
description: Response
@@ -55236,9 +54807,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -55307,7 +54878,7 @@ paths:
items:
type: object
properties:
- type: &475
+ type: &472
type: string
description: The type of reviewer.
enum:
@@ -55393,9 +54964,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: true
content:
@@ -55445,7 +55016,7 @@ paths:
application/json:
schema:
type: array
- items: &470
+ items: &467
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -55557,7 +55128,7 @@ paths:
- created_at
- updated_at
examples:
- default: &471
+ default: &468
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -55613,9 +55184,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: false
content:
@@ -55660,9 +55231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: false
content:
@@ -55716,9 +55287,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -55855,8 +55426,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -55874,9 +55445,9 @@ paths:
type: integer
secrets:
type: array
- items: *359
+ items: *356
examples:
- default: *360
+ default: *357
headers:
Link: *56
x-github:
@@ -55901,16 +55472,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55932,17 +55503,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: &488
+ default: &485
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -55968,8 +55539,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -56027,8 +55598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -56054,9 +55625,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *314
- - *315
- - *330
+ - *311
+ - *312
+ - *327
- *19
responses:
'200':
@@ -56073,9 +55644,9 @@ paths:
type: integer
variables:
type: array
- items: *363
+ items: *360
examples:
- default: *364
+ default: *361
headers:
Link: *56
x-github:
@@ -56098,8 +55669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -56151,17 +55722,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
responses:
'200':
description: Response
content:
application/json:
- schema: *363
+ schema: *360
examples:
- default: &489
+ default: &486
value:
name: USERNAME
value: octocat
@@ -56187,8 +55758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
requestBody:
required: true
@@ -56231,8 +55802,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
responses:
'204':
@@ -56258,8 +55829,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -56277,7 +55848,7 @@ paths:
type: integer
workflows:
type: array
- items: &365
+ items: &362
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -56395,9 +55966,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *314
- - *315
- - &366
+ - *311
+ - *312
+ - &363
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -56412,7 +55983,7 @@ paths:
description: Response
content:
application/json:
- schema: *365
+ schema: *362
examples:
default:
value:
@@ -56445,9 +56016,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56472,9 +56043,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56525,9 +56096,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56554,19 +56125,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *363
+ - *364
+ - *365
- *366
- *367
+ - *17
+ - *19
- *368
+ - *347
- *369
- *370
- - *17
- - *19
- - *371
- - *350
- - *372
- - *373
responses:
'200':
description: Response
@@ -56582,9 +56153,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *351
+ items: *348
examples:
- default: *374
+ default: *371
headers:
Link: *56
x-github:
@@ -56616,9 +56187,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'200':
description: Response
@@ -56679,8 +56250,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *50
- *17
- *43
@@ -56848,8 +56419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -56886,8 +56457,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: assignee
in: path
required: true
@@ -56923,8 +56494,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -57036,8 +56607,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *43
- *44
@@ -57094,7 +56665,7 @@ paths:
initiator:
type: string
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57114,8 +56685,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -57123,7 +56694,7 @@ paths:
application/json:
schema:
type: array
- items: &376
+ items: &373
title: Autolink reference
description: An autolink reference.
type: object
@@ -57182,8 +56753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -57222,9 +56793,9 @@ paths:
description: response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: &377
+ default: &374
value:
id: 1
key_prefix: TICKET-
@@ -57255,9 +56826,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *314
- - *315
- - &378
+ - *311
+ - *312
+ - &375
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -57269,9 +56840,9 @@ paths:
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: *377
+ default: *374
'404': *6
x-github:
githubCloudOnly: false
@@ -57291,9 +56862,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *314
- - *315
- - *378
+ - *311
+ - *312
+ - *375
responses:
'204':
description: Response
@@ -57317,8 +56888,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response if Dependabot is enabled
@@ -57368,8 +56939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -57390,8 +56961,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -57411,8 +56982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -57450,7 +57021,7 @@ paths:
- url
protected:
type: boolean
- protection: &380
+ protection: &377
title: Branch Protection
description: Branch Protection
type: object
@@ -57493,7 +57064,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &383
+ enforce_admins: &380
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -57510,7 +57081,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &385
+ required_pull_request_reviews: &382
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -57594,7 +57165,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &382
+ restrictions: &379
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -57887,9 +57458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *314
- - *315
- - &381
+ - *311
+ - *312
+ - &378
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).
@@ -57903,14 +57474,14 @@ paths:
description: Response
content:
application/json:
- schema: &391
+ schema: &388
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &445
+ commit: &442
title: Commit
description: Commit
type: object
@@ -57949,7 +57520,7 @@ paths:
author:
anyOf:
- type: 'null'
- - &379
+ - &376
title: Git User
description: Metaproperties for Git author/committer
information.
@@ -57971,7 +57542,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
message:
type: string
examples:
@@ -57995,7 +57566,7 @@ paths:
required:
- sha
- url
- verification: &495
+ verification: &492
title: Verification
type: object
properties:
@@ -58075,7 +57646,7 @@ paths:
type: integer
files:
type: array
- items: &456
+ items: &453
title: Diff Entry
description: Diff Entry
type: object
@@ -58171,7 +57742,7 @@ paths:
- self
protected:
type: boolean
- protection: *380
+ protection: *377
protection_url:
type: string
format: uri
@@ -58280,7 +57851,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *318
+ '301': *315
'404': *6
x-github:
githubCloudOnly: false
@@ -58302,15 +57873,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *380
+ schema: *377
examples:
default:
value:
@@ -58504,9 +58075,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -58766,7 +58337,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &388
+ required_status_checks: &385
title: Status Check Policy
description: Status Check Policy
type: object
@@ -58925,7 +58496,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *382
+ restrictions: *379
required_conversation_resolution:
type: object
properties:
@@ -59037,9 +58608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59064,17 +58635,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: &384
+ default: &381
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -59096,17 +58667,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: *384
+ default: *381
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59125,9 +58696,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59152,17 +58723,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *385
+ schema: *382
examples:
- default: &386
+ default: &383
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -59258,9 +58829,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59358,9 +58929,9 @@ paths:
description: Response
content:
application/json:
- schema: *385
+ schema: *382
examples:
- default: *386
+ default: *383
'422': *15
x-github:
githubCloudOnly: false
@@ -59381,9 +58952,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59410,17 +58981,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: &387
+ default: &384
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -59443,17 +59014,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: *387
+ default: *384
'404': *6
x-github:
githubCloudOnly: false
@@ -59473,9 +59044,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59500,17 +59071,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *388
+ schema: *385
examples:
- default: &389
+ default: &386
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -59536,9 +59107,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59590,9 +59161,9 @@ paths:
description: Response
content:
application/json:
- schema: *388
+ schema: *385
examples:
- default: *389
+ default: *386
'404': *6
'422': *15
x-github:
@@ -59614,9 +59185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59640,9 +59211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -59676,9 +59247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59745,9 +59316,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59811,9 +59382,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
content:
application/json:
@@ -59879,15 +59450,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *382
+ schema: *379
examples:
default:
value:
@@ -59978,9 +59549,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -60003,9 +59574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60015,7 +59586,7 @@ paths:
type: array
items: *5
examples:
- default: &390
+ default: &387
value:
- id: 1
slug: octoapp
@@ -60072,9 +59643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60108,7 +59679,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60129,9 +59700,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60165,7 +59736,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60186,9 +59757,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60222,7 +59793,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60244,9 +59815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60276,9 +59847,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -60337,9 +59908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -60398,9 +59969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
content:
application/json:
@@ -60459,9 +60030,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60495,9 +60066,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60555,9 +60126,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60615,9 +60186,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60677,9 +60248,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60701,7 +60272,7 @@ paths:
description: Response
content:
application/json:
- schema: *391
+ schema: *388
examples:
default:
value:
@@ -60817,8 +60388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -61097,7 +60668,7 @@ paths:
description: Response
content:
application/json:
- schema: &392
+ schema: &389
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -61233,7 +60804,7 @@ paths:
check.
type: array
items: *74
- deployment: &705
+ deployment: &700
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -61520,9 +61091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *314
- - *315
- - &393
+ - *311
+ - *312
+ - &390
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -61534,9 +61105,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: &394
+ default: &391
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -61636,9 +61207,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
requestBody:
required: true
content:
@@ -61878,9 +61449,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: *394
+ default: *391
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61900,9 +61471,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
- *17
- *19
responses:
@@ -62012,9 +61583,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
responses:
'201':
description: Response
@@ -62058,8 +61629,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -62081,7 +61652,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &396
+ schema: &393
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -62179,7 +61750,7 @@ paths:
- string
- 'null'
format: date-time
- head_commit: *395
+ head_commit: *392
latest_check_runs_count:
type: integer
check_runs_url:
@@ -62207,7 +61778,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &397
+ default: &394
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -62498,9 +62069,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62519,8 +62090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -62829,9 +62400,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *314
- - *315
- - &398
+ - *311
+ - *312
+ - &395
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -62843,9 +62414,9 @@ paths:
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62868,17 +62439,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *314
- - *315
- - *398
- - &451
+ - *311
+ - *312
+ - *395
+ - &448
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &452
+ - &449
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -62917,9 +62488,9 @@ paths:
type: integer
check_runs:
type: array
- items: *392
+ items: *389
examples:
- default: &453
+ default: &450
value:
total_count: 1
check_runs:
@@ -63021,9 +62592,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *314
- - *315
- - *398
+ - *311
+ - *312
+ - *395
responses:
'201':
description: Response
@@ -63056,21 +62627,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *314
- - *315
- - *399
- - *400
+ - *311
+ - *312
+ - *396
+ - *397
- *19
- *17
- - &417
+ - &414
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: *401
- - &418
+ schema: *398
+ - &415
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -63095,13 +62666,13 @@ paths:
be returned.
in: query
required: false
- schema: *402
+ schema: *399
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *403
+ schema: *400
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -63125,7 +62696,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: *404
+ instances_url: *401
state: *171
fixed_at: *167
dismissed_by:
@@ -63133,11 +62704,11 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: *405
- dismissed_comment: *406
- rule: *407
- tool: *408
- most_recent_instance: *409
+ dismissed_reason: *402
+ dismissed_comment: *403
+ rule: *404
+ tool: *405
+ most_recent_instance: *406
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -63260,7 +62831,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *35
- '403': &410
+ '403': &407
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -63287,9 +62858,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *314
- - *315
- - &411
+ - *311
+ - *312
+ - &408
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -63303,7 +62874,7 @@ paths:
description: Response
content:
application/json:
- schema: &412
+ schema: &409
type: object
properties:
number: *162
@@ -63311,7 +62882,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: *404
+ instances_url: *401
state: *171
fixed_at: *167
dismissed_by:
@@ -63319,8 +62890,8 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: *405
- dismissed_comment: *406
+ dismissed_reason: *402
+ dismissed_comment: *403
rule:
type: object
properties:
@@ -63382,8 +62953,8 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: *408
- most_recent_instance: *409
+ tool: *405
+ most_recent_instance: *406
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -63479,7 +63050,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *35
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63499,9 +63070,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: true
content:
@@ -63516,8 +63087,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *405
- dismissed_comment: *406
+ dismissed_reason: *402
+ dismissed_comment: *403
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -63545,7 +63116,7 @@ paths:
description: Response
content:
application/json:
- schema: *412
+ schema: *409
examples:
default:
value:
@@ -63621,7 +63192,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &416
+ '403': &413
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -63648,15 +63219,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
responses:
'200':
description: Response
content:
application/json:
- schema: &413
+ schema: &410
type: object
properties:
status:
@@ -63683,13 +63254,13 @@ paths:
- description
- started_at
examples:
- default: &414
+ default: &411
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &415
+ '400': &412
description: Bad Request
content:
application/json:
@@ -63700,7 +63271,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': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63725,29 +63296,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
responses:
'200':
description: OK
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
'202':
description: Accepted
content:
application/json:
- schema: *413
+ schema: *410
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *415
+ '400': *412
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -63779,9 +63350,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: false
content:
@@ -63827,8 +63398,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *415
- '403': *416
+ '400': *412
+ '403': *413
'404': *6
'422':
description: Unprocessable Entity
@@ -63852,13 +63423,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
- *19
- *17
- - *417
- - *418
+ - *414
+ - *415
responses:
'200':
description: Response
@@ -63869,10 +63440,10 @@ paths:
items:
type: object
properties:
- ref: *401
- analysis_key: *419
- environment: *420
- category: *421
+ ref: *398
+ analysis_key: *416
+ environment: *417
+ category: *418
state:
type:
- string
@@ -63889,7 +63460,7 @@ paths:
properties:
text:
type: string
- location: *422
+ location: *419
html_url:
type: string
classifications:
@@ -63897,7 +63468,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: *423
+ items: *420
examples:
default:
value:
@@ -63936,7 +63507,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63970,25 +63541,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *314
- - *315
- - *399
- - *400
+ - *311
+ - *312
+ - *396
+ - *397
- *19
- *17
- - *418
+ - *415
- 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: *401
+ schema: *398
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &424
+ schema: &421
type: string
description: An identifier for the upload.
examples:
@@ -64010,23 +63581,23 @@ paths:
application/json:
schema:
type: array
- items: &425
+ items: &422
type: object
properties:
- ref: *401
- commit_sha: &433
+ ref: *398
+ commit_sha: &430
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: *419
+ analysis_key: *416
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *421
+ category: *418
error:
type: string
examples:
@@ -64051,8 +63622,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *424
- tool: *408
+ sarif_id: *421
+ tool: *405
deletable:
type: boolean
warning:
@@ -64114,7 +63685,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64150,8 +63721,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:
- - *314
- - *315
+ - *311
+ - *312
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -64164,7 +63735,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
response:
summary: application/json response
@@ -64218,7 +63789,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *410
+ '403': *407
'404': *6
'422':
description: Response if analysis could not be processed
@@ -64305,8 +63876,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:
- - *314
- - *315
+ - *311
+ - *312
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -64362,7 +63933,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': *416
+ '403': *413
'404': *6
'503': *105
x-github:
@@ -64384,8 +63955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -64393,7 +63964,7 @@ paths:
application/json:
schema:
type: array
- items: &426
+ items: &423
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -64505,7 +64076,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': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64534,8 +64105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: language
in: path
description: The language of the CodeQL database.
@@ -64547,7 +64118,7 @@ paths:
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -64579,9 +64150,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': &458
+ '302': &455
description: Found
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64603,8 +64174,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: language
in: path
description: The language of the CodeQL database.
@@ -64614,7 +64185,7 @@ paths:
responses:
'204':
description: Response
- '403': *416
+ '403': *413
'404': *6
'503': *105
x-github:
@@ -64642,8 +64213,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -64652,7 +64223,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &427
+ language: &424
type: string
description: The language targeted by the CodeQL query
enum:
@@ -64732,7 +64303,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &431
+ schema: &428
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -64742,7 +64313,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *55
actor: *4
- query_language: *427
+ query_language: *424
query_pack_url:
type: string
description: The download url for the query pack.
@@ -64790,7 +64361,7 @@ paths:
items:
type: object
properties:
- repository: &428
+ repository: &425
title: Repository Identifier
description: Repository Identifier
type: object
@@ -64832,7 +64403,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &432
+ analysis_status: &429
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -64864,7 +64435,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &429
+ access_mismatch_repos: &426
type: object
properties:
repository_count:
@@ -64879,7 +64450,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: *428
+ items: *425
required:
- repository_count
- repositories
@@ -64902,8 +64473,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *429
- over_limit_repos: *429
+ no_codeql_db_repos: *426
+ over_limit_repos: *426
required:
- access_mismatch_repos
- not_found_repos
@@ -64919,7 +64490,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &430
+ value: &427
summary: Default response
value:
id: 1
@@ -65065,10 +64636,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *430
+ value: *427
repository_lists:
summary: Response for a successful variant analysis submission
- value: *430
+ value: *427
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -65096,8 +64667,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:
- - *314
- - *315
+ - *311
+ - *312
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -65109,9 +64680,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: *430
+ default: *427
'404': *6
'503': *105
x-github:
@@ -65134,7 +64705,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:
- - *314
+ - *311
- name: repo
in: path
description: The name of the controller repository.
@@ -65169,7 +64740,7 @@ paths:
type: object
properties:
repository: *55
- analysis_status: *432
+ analysis_status: *429
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -65294,8 +64865,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -65388,7 +64959,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -65409,8 +64980,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -65504,7 +65075,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *416
+ '403': *413
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -65575,8 +65146,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -65584,7 +65155,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *433
+ commit_sha: *430
ref:
type: string
description: |-
@@ -65644,7 +65215,7 @@ paths:
schema:
type: object
properties:
- id: *424
+ id: *421
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -65658,7 +65229,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': *416
+ '403': *413
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -65681,8 +65252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -65730,7 +65301,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': *410
+ '403': *407
'404':
description: Not Found if the sarif id does not match any upload
'503': *105
@@ -65755,8 +65326,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -65837,8 +65408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -65966,8 +65537,8 @@ paths:
parameters:
- *17
- *19
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -66281,8 +65852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -66348,7 +65919,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -66356,7 +65927,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'400': *14
'401': *23
'403': *27
@@ -66385,8 +65956,8 @@ paths:
parameters:
- *17
- *19
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -66450,8 +66021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -66488,9 +66059,9 @@ paths:
type: integer
machines:
type: array
- items: *435
+ items: *432
examples:
- default: &651
+ default: &646
value:
total_count: 2
machines:
@@ -66530,8 +66101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -66618,8 +66189,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:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -66688,8 +66259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -66707,7 +66278,7 @@ paths:
type: integer
secrets:
type: array
- items: &439
+ items: &436
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -66728,7 +66299,7 @@ paths:
- created_at
- updated_at
examples:
- default: *436
+ default: *433
headers:
Link: *56
x-github:
@@ -66751,16 +66322,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *437
+ schema: *434
examples:
- default: *438
+ default: *435
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -66780,17 +66351,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66810,8 +66381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -66864,8 +66435,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -66894,8 +66465,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -66933,7 +66504,7 @@ paths:
application/json:
schema:
type: array
- items: &441
+ items: &438
title: Collaborator
description: Collaborator
type: object
@@ -67126,8 +66697,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'204':
@@ -67174,8 +66745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
requestBody:
required: false
@@ -67202,7 +66773,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &508
+ schema: &505
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -67430,8 +67001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'204':
@@ -67463,8 +67034,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'200':
@@ -67485,7 +67056,7 @@ paths:
user:
anyOf:
- type: 'null'
- - *441
+ - *438
required:
- permission
- role_name
@@ -67539,8 +67110,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -67550,7 +67121,7 @@ paths:
application/json:
schema:
type: array
- items: &442
+ items: &439
title: Commit Comment
description: Commit Comment
type: object
@@ -67608,7 +67179,7 @@ paths:
- created_at
- updated_at
examples:
- default: &447
+ default: &444
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -67667,17 +67238,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: &448
+ default: &445
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -67734,8 +67305,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -67758,7 +67329,7 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
default:
value:
@@ -67809,8 +67380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -67832,8 +67403,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -67860,7 +67431,7 @@ paths:
application/json:
schema:
type: array
- items: &443
+ items: &440
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -67904,7 +67475,7 @@ paths:
- content
- created_at
examples:
- default: &512
+ default: &509
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -67949,8 +67520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -67983,9 +67554,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: &444
+ default: &441
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -68014,9 +67585,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -68038,10 +67609,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - &513
+ - &510
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -68096,8 +67667,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -68153,9 +67724,9 @@ paths:
application/json:
schema:
type: array
- items: *445
+ items: *442
examples:
- default: &559
+ default: &556
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -68249,9 +67820,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *314
- - *315
- - &446
+ - *311
+ - *312
+ - &443
name: commit_sha
description: The SHA of the commit.
in: path
@@ -68323,9 +67894,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
- *17
- *19
responses:
@@ -68335,9 +67906,9 @@ paths:
application/json:
schema:
type: array
- items: *442
+ items: *439
examples:
- default: *447
+ default: *444
headers:
Link: *56
x-github:
@@ -68365,9 +67936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
requestBody:
required: true
content:
@@ -68402,9 +67973,9 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: *448
+ default: *445
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -68432,9 +68003,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
- *17
- *19
responses:
@@ -68444,9 +68015,9 @@ paths:
application/json:
schema:
type: array
- items: *449
+ items: *446
examples:
- default: &551
+ default: &548
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -68983,11 +68554,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
- - &450
+ - &447
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)"
@@ -69002,9 +68573,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: &537
+ default: &534
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -69117,11 +68688,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *314
- - *315
- - *450
- - *451
- - *452
+ - *311
+ - *312
+ - *447
+ - *448
+ - *449
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -69155,9 +68726,9 @@ paths:
type: integer
check_runs:
type: array
- items: *392
+ items: *389
examples:
- default: *453
+ default: *450
headers:
Link: *56
x-github:
@@ -69182,9 +68753,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -69192,7 +68763,7 @@ paths:
schema:
type: integer
example: 1
- - *451
+ - *448
- *17
- *19
responses:
@@ -69210,7 +68781,7 @@ paths:
type: integer
check_suites:
type: array
- items: *396
+ items: *393
examples:
default:
value:
@@ -69410,9 +68981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- *17
- *19
responses:
@@ -69614,9 +69185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- *17
- *19
responses:
@@ -69626,7 +69197,7 @@ paths:
application/json:
schema:
type: array
- items: &624
+ items: &621
title: Status
description: The status of a commit.
type: object
@@ -69707,7 +69278,7 @@ paths:
site_admin: false
headers:
Link: *56
- '301': *318
+ '301': *315
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69735,8 +69306,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -69769,11 +69340,11 @@ paths:
code_of_conduct:
anyOf:
- type: 'null'
- - *454
+ - *451
code_of_conduct_file:
anyOf:
- type: 'null'
- - &455
+ - &452
title: Community Health File
type: object
properties:
@@ -69793,19 +69364,19 @@ paths:
contributing:
anyOf:
- type: 'null'
- - *455
+ - *452
readme:
anyOf:
- type: 'null'
- - *455
+ - *452
issue_template:
anyOf:
- type: 'null'
- - *455
+ - *452
pull_request_template:
anyOf:
- type: 'null'
- - *455
+ - *452
required:
- code_of_conduct
- code_of_conduct_file
@@ -69934,8 +69505,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
- name: basehead
@@ -69983,8 +69554,8 @@ paths:
format: uri
examples:
- https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *445
- merge_base_commit: *445
+ base_commit: *442
+ merge_base_commit: *442
status:
type: string
enum:
@@ -70008,10 +69579,10 @@ paths:
- 6
commits:
type: array
- items: *445
+ items: *442
files:
type: array
- items: *456
+ items: *453
required:
- url
- html_url
@@ -70297,8 +69868,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -70451,7 +70022,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &457
+ response-if-content-is-a-file: &454
summary: Response if content is a file
value:
type: file
@@ -70588,7 +70159,7 @@ paths:
- size
- type
- url
- - &564
+ - &561
title: Content File
description: Content File
type: object
@@ -70806,7 +70377,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *457
+ response-if-content-is-a-file: *454
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -70875,7 +70446,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *27
- '302': *458
+ '302': *455
'304': *35
x-github:
githubCloudOnly: false
@@ -70898,8 +70469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -70994,7 +70565,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: File Commit
description: File Commit
type: object
@@ -71150,7 +70721,7 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
example-for-creating-a-file:
value:
@@ -71204,7 +70775,7 @@ paths:
schema:
oneOf:
- *3
- - &490
+ - &487
description: Repository rule violation was detected
type: object
properties:
@@ -71225,7 +70796,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &616
+ placeholder_id: &613
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -71257,8 +70828,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -71319,7 +70890,7 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
default:
value:
@@ -71374,8 +70945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -71499,8 +71070,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *181
- *182
- *183
@@ -71512,7 +71083,7 @@ paths:
schema:
type: string
- *185
- - *460
+ - *457
- *186
- *187
- *50
@@ -71533,7 +71104,7 @@ paths:
application/json:
schema:
type: array
- items: &464
+ items: &461
type: object
description: A Dependabot alert.
properties:
@@ -71583,7 +71154,7 @@ paths:
- direct
- transitive
-
- security_advisory: *461
+ security_advisory: *458
security_vulnerability: *54
url: *165
html_url: *166
@@ -71614,8 +71185,8 @@ paths:
dismissal.
maxLength: 280
fixed_at: *167
- auto_dismissed_at: *462
- dismissal_request: *463
+ auto_dismissed_at: *459
+ dismissal_request: *460
required:
- number
- state
@@ -71845,9 +71416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *314
- - *315
- - &465
+ - *311
+ - *312
+ - &462
name: alert_number
in: path
description: |-
@@ -71862,7 +71433,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -71975,9 +71546,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *314
- - *315
- - *465
+ - *311
+ - *312
+ - *462
requestBody:
required: true
content:
@@ -72022,7 +71593,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -72151,8 +71722,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -72170,7 +71741,7 @@ paths:
type: integer
secrets:
type: array
- items: &468
+ items: &465
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -72224,16 +71795,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *466
+ schema: *463
examples:
- default: *467
+ default: *464
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72253,15 +71824,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -72287,8 +71858,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -72341,8 +71912,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -72365,8 +71936,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:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -72540,8 +72111,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -72801,8 +72372,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -72885,7 +72456,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &469
+ metadata: &466
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -72924,7 +72495,7 @@ paths:
examples:
- "/src/build/package-lock.json"
additionalProperties: false
- metadata: *469
+ metadata: *466
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -72938,7 +72509,7 @@ paths:
pattern: "^pkg"
examples:
- pkg:/npm/%40actions/http-client@1.0.11
- metadata: *469
+ metadata: *466
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -73071,8 +72642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -73113,9 +72684,9 @@ paths:
application/json:
schema:
type: array
- items: *470
+ items: *467
examples:
- default: *471
+ default: *468
headers:
Link: *56
x-github:
@@ -73181,8 +72752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -73264,7 +72835,7 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
simple-example:
summary: Simple example
@@ -73337,9 +72908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *314
- - *315
- - &472
+ - *311
+ - *312
+ - &469
name: deployment_id
description: deployment_id parameter
in: path
@@ -73351,7 +72922,7 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
default:
value:
@@ -73416,9 +72987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
responses:
'204':
description: Response
@@ -73440,9 +73011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
- *17
- *19
responses:
@@ -73452,7 +73023,7 @@ paths:
application/json:
schema:
type: array
- items: &473
+ items: &470
title: Deployment Status
description: The status of a deployment.
type: object
@@ -73616,9 +73187,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
requestBody:
required: true
content:
@@ -73693,9 +73264,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *470
examples:
- default: &474
+ default: &471
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -73751,9 +73322,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
- name: status_id
in: path
required: true
@@ -73764,9 +73335,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *470
examples:
- default: *474
+ default: *471
'404': *6
x-github:
githubCloudOnly: false
@@ -73791,8 +73362,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -73849,8 +73420,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -73868,7 +73439,7 @@ paths:
- 5
environments:
type: array
- items: &476
+ items: &473
title: Environment
description: Details of a deployment environment
type: object
@@ -73930,7 +73501,7 @@ paths:
type: string
examples:
- wait_timer
- wait_timer: &478
+ wait_timer: &475
type: integer
description: The amount of time to delay a job after
the job is initially triggered. The time (in minutes)
@@ -73972,7 +73543,7 @@ paths:
items:
type: object
properties:
- type: *475
+ type: *472
reviewer:
anyOf:
- *4
@@ -73999,7 +73570,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &479
+ deployment_branch_policy: &476
type:
- object
- 'null'
@@ -74116,9 +73687,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *314
- - *315
- - &477
+ - *311
+ - *312
+ - &474
name: environment_name
in: path
required: true
@@ -74131,9 +73702,9 @@ paths:
description: Response
content:
application/json:
- schema: *476
+ schema: *473
examples:
- default: &480
+ default: &477
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -74217,9 +73788,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: false
content:
@@ -74229,7 +73800,7 @@ paths:
- object
- 'null'
properties:
- wait_timer: *478
+ wait_timer: *475
prevent_self_review:
type: boolean
description: Whether or not a user who created the job is prevented
@@ -74248,14 +73819,14 @@ paths:
items:
type: object
properties:
- type: *475
+ type: *472
id:
type: integer
description: The id of the user or team who can review the
deployment
examples:
- 4532992
- deployment_branch_policy: *479
+ deployment_branch_policy: *476
additionalProperties: false
examples:
default:
@@ -74275,9 +73846,9 @@ paths:
description: Response
content:
application/json:
- schema: *476
+ schema: *473
examples:
- default: *480
+ default: *477
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -74301,9 +73872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
responses:
'204':
description: Default response
@@ -74328,9 +73899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *17
- *19
responses:
@@ -74349,7 +73920,7 @@ paths:
- 2
branch_policies:
type: array
- items: &481
+ items: &478
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -74410,9 +73981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: true
content:
@@ -74460,9 +74031,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- example-wildcard: &482
+ example-wildcard: &479
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -74504,10 +74075,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - &483
+ - *311
+ - *312
+ - *474
+ - &480
name: branch_policy_id
in: path
required: true
@@ -74519,9 +74090,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- default: *482
+ default: *479
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74540,10 +74111,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - *483
+ - *311
+ - *312
+ - *474
+ - *480
requestBody:
required: true
content:
@@ -74572,9 +74143,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- default: *482
+ default: *479
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74593,10 +74164,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - *483
+ - *311
+ - *312
+ - *474
+ - *480
responses:
'204':
description: Response
@@ -74621,9 +74192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
responses:
'200':
description: List of deployment protection rules
@@ -74640,7 +74211,7 @@ paths:
- 10
custom_deployment_protection_rules:
type: array
- items: &484
+ items: &481
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -74662,7 +74233,7 @@ paths:
for the environment.
examples:
- true
- app: &485
+ app: &482
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -74765,9 +74336,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:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
requestBody:
content:
application/json:
@@ -74788,9 +74359,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: &486
+ default: &483
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -74825,9 +74396,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:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
- *19
- *17
responses:
@@ -74847,7 +74418,7 @@ paths:
- 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *485
+ items: *482
examples:
default:
value:
@@ -74882,10 +74453,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *314
- - *315
- - *477
- - &487
+ - *311
+ - *312
+ - *474
+ - &484
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -74897,9 +74468,9 @@ paths:
description: Response
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: *486
+ default: *483
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74920,10 +74491,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *477
- - *315
- - *314
- - *487
+ - *474
+ - *312
+ - *311
+ - *484
responses:
'204':
description: Response
@@ -74949,9 +74520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *17
- *19
responses:
@@ -74969,9 +74540,9 @@ paths:
type: integer
secrets:
type: array
- items: *359
+ items: *356
examples:
- default: *360
+ default: *357
headers:
Link: *56
x-github:
@@ -74996,17 +74567,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75028,18 +74599,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: *488
+ default: *485
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75061,9 +74632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
requestBody:
required: true
@@ -75121,9 +74692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
responses:
'204':
@@ -75149,10 +74720,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *314
- - *315
- - *477
- - *330
+ - *311
+ - *312
+ - *474
+ - *327
- *19
responses:
'200':
@@ -75169,9 +74740,9 @@ paths:
type: integer
variables:
type: array
- items: *363
+ items: *360
examples:
- default: *364
+ default: *361
headers:
Link: *56
x-github:
@@ -75194,9 +74765,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: true
content:
@@ -75248,18 +74819,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *155
responses:
'200':
description: Response
content:
application/json:
- schema: *363
+ schema: *360
examples:
- default: *489
+ default: *486
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75280,10 +74851,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
- - *477
+ - *474
requestBody:
required: true
content:
@@ -75325,10 +74896,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
- - *477
+ - *474
responses:
'204':
description: Response
@@ -75350,8 +74921,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -75419,8 +74990,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -75579,8 +75150,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -75613,9 +75184,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
'400': *14
'422': *15
'403': *27
@@ -75636,8 +75207,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -75697,7 +75268,7 @@ paths:
schema:
oneOf:
- *113
- - *490
+ - *487
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75722,8 +75293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: file_sha
in: path
required: true
@@ -75823,8 +75394,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -75933,7 +75504,7 @@ paths:
description: Response
content:
application/json:
- schema: &491
+ schema: &488
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -76160,15 +75731,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
responses:
'200':
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
default:
value:
@@ -76224,9 +75795,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *314
- - *315
- - &492
+ - *311
+ - *312
+ - &489
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.
@@ -76243,7 +75814,7 @@ paths:
application/json:
schema:
type: array
- items: &493
+ items: &490
title: Git Reference
description: Git references within a repository
type: object
@@ -76319,17 +75890,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: &494
+ default: &491
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -76358,8 +75929,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76388,9 +75959,9 @@ paths:
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *494
+ default: *491
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -76416,9 +75987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
requestBody:
required: true
content:
@@ -76447,9 +76018,9 @@ paths:
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *494
+ default: *491
'422': *15
'409': *49
x-github:
@@ -76467,9 +76038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
responses:
'204':
description: Response
@@ -76524,8 +76095,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76592,7 +76163,7 @@ paths:
description: Response
content:
application/json:
- schema: &496
+ schema: &493
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -76648,7 +76219,7 @@ paths:
- sha
- type
- url
- verification: *495
+ verification: *492
required:
- sha
- url
@@ -76658,7 +76229,7 @@ paths:
- tag
- message
examples:
- default: &497
+ default: &494
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -76731,8 +76302,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tag_sha
in: path
required: true
@@ -76743,9 +76314,9 @@ paths:
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
- default: *497
+ default: *494
'404': *6
'409': *49
x-github:
@@ -76769,8 +76340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76844,7 +76415,7 @@ paths:
description: Response
content:
application/json:
- schema: &498
+ schema: &495
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -76946,8 +76517,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -76970,7 +76541,7 @@ paths:
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
default-response:
summary: Default response
@@ -77029,8 +76600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -77040,7 +76611,7 @@ paths:
application/json:
schema:
type: array
- items: &499
+ items: &496
title: Webhook
description: Webhooks for repositories.
type: object
@@ -77103,7 +76674,7 @@ paths:
format: uri
examples:
- https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &736
+ last_response: &731
title: Hook Response
type: object
properties:
@@ -77180,8 +76751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -77234,9 +76805,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &500
+ default: &497
value:
type: Repository
id: 12345678
@@ -77284,17 +76855,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
'404': *6
x-github:
githubCloudOnly: false
@@ -77314,8 +76885,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
requestBody:
required: true
@@ -77361,9 +76932,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
'422': *15
'404': *6
x-github:
@@ -77384,8 +76955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77410,8 +76981,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'200':
@@ -77439,8 +77010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
requestBody:
required: false
@@ -77485,8 +77056,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *17
- *194
@@ -77518,8 +77089,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *16
responses:
@@ -77548,8 +77119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *16
responses:
@@ -77573,8 +77144,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77600,8 +77171,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77625,8 +77196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response if immutable releases are enabled
@@ -77674,8 +77245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'409': *49
@@ -77695,8 +77266,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'409': *49
@@ -77753,14 +77324,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &501
+ schema: &498
title: Import
description: A repository import from an external source.
type: object
@@ -77867,7 +77438,7 @@ paths:
- html_url
- authors_url
examples:
- default: &504
+ default: &501
value:
vcs: subversion
use_lfs: true
@@ -77883,7 +77454,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': &502
+ '503': &499
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -77912,8 +77483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -77961,7 +77532,7 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
default:
value:
@@ -77986,7 +77557,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78014,8 +77585,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -78067,7 +77638,7 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
example-1:
summary: Example 1
@@ -78115,7 +77686,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': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78138,12 +77709,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78169,9 +77740,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *314
- - *315
- - &672
+ - *311
+ - *312
+ - &667
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -78185,7 +77756,7 @@ paths:
application/json:
schema:
type: array
- items: &503
+ items: &500
title: Porter Author
description: Porter Author
type: object
@@ -78239,7 +77810,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': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78264,8 +77835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: author_id
in: path
required: true
@@ -78295,7 +77866,7 @@ paths:
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
default:
value:
@@ -78308,7 +77879,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78332,8 +77903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78374,7 +77945,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78402,8 +77973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -78430,11 +78001,11 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: *504
+ default: *501
'422': *15
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78457,8 +78028,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78466,8 +78037,8 @@ paths:
application/json:
schema: *20
examples:
- default: *505
- '301': *318
+ default: *502
+ '301': *315
'404': *6
x-github:
githubCloudOnly: false
@@ -78487,8 +78058,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78501,7 +78072,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &507
+ default: &504
value:
limit: collaborators_only
origin: repository
@@ -78526,13 +78097,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *506
+ schema: *503
examples:
default:
summary: Example request body
@@ -78546,7 +78117,7 @@ paths:
application/json:
schema: *211
examples:
- default: *507
+ default: *504
'409':
description: Response
x-github:
@@ -78568,8 +78139,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -78592,8 +78163,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -78603,9 +78174,9 @@ paths:
application/json:
schema:
type: array
- items: *508
+ items: *505
examples:
- default: &665
+ default: &660
value:
- id: 1
repository:
@@ -78736,8 +78307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *215
requestBody:
required: false
@@ -78767,7 +78338,7 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
default:
value:
@@ -78898,8 +78469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *215
responses:
'204':
@@ -78931,8 +78502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -79005,7 +78576,7 @@ paths:
type: array
items: *70
examples:
- default: &518
+ default: &515
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -79153,7 +78724,7 @@ paths:
state_reason: completed
headers:
Link: *56
- '301': *318
+ '301': *315
'422': *15
'404': *6
x-github:
@@ -79182,8 +78753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -79275,7 +78846,7 @@ paths:
application/json:
schema: *70
examples:
- default: &515
+ default: &512
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -79431,7 +79002,7 @@ paths:
'422': *15
'503': *105
'404': *6
- '410': *509
+ '410': *506
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -79459,8 +79030,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *93
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -79481,9 +79052,9 @@ paths:
application/json:
schema:
type: array
- items: *510
+ items: *507
examples:
- default: &517
+ default: &514
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -79541,17 +79112,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: &511
+ default: &508
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -79605,8 +79176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -79629,9 +79200,9 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
'422': *15
x-github:
githubCloudOnly: false
@@ -79649,8 +79220,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -79671,8 +79242,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -79699,9 +79270,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -79722,8 +79293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -79756,16 +79327,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -79787,10 +79358,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - *513
+ - *510
responses:
'204':
description: Response
@@ -79810,8 +79381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -79821,7 +79392,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Issue Event
description: Issue Event
type: object
@@ -80160,8 +79731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: event_id
in: path
required: true
@@ -80172,7 +79743,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -80364,7 +79935,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *509
+ '410': *506
'403': *27
x-github:
githubCloudOnly: false
@@ -80398,9 +79969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *314
- - *315
- - &516
+ - *311
+ - *312
+ - &513
name: issue_number
description: The number that identifies the issue.
in: path
@@ -80414,10 +79985,10 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'304': *35
x-github:
githubCloudOnly: false
@@ -80442,9 +80013,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -80565,13 +80136,13 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
'422': *15
'503': *105
'403': *27
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80589,9 +80160,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -80619,7 +80190,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80635,9 +80206,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
content:
application/json:
@@ -80664,7 +80235,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80686,9 +80257,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:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: assignee
in: path
required: true
@@ -80728,9 +80299,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *76
- *17
- *19
@@ -80741,13 +80312,13 @@ paths:
application/json:
schema:
type: array
- items: *510
+ items: *507
examples:
- default: *517
+ default: *514
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80776,9 +80347,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -80800,16 +80371,16 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -80837,9 +80408,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -80851,12 +80422,12 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80884,9 +80455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -80910,15 +80481,15 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *318
+ '301': *315
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -80949,9 +80520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -80965,13 +80536,13 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'400': *14
'401': *23
'403': *27
'404': *6
- '410': *509
+ '410': *506
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -80997,9 +80568,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81011,12 +80582,12 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81033,9 +80604,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81049,7 +80620,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &520
+ - &517
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -81098,7 +80669,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &521
+ - &518
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -81226,7 +80797,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &522
+ - &519
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -81272,7 +80843,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &523
+ - &520
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -81318,7 +80889,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &524
+ - &521
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -81367,7 +80938,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &525
+ - &522
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -81409,7 +80980,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &526
+ - &523
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -81451,7 +81022,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &527
+ - &524
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -81507,7 +81078,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &528
+ - &525
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -81552,7 +81123,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &529
+ - &526
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -81613,7 +81184,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &530
+ - &527
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -81674,7 +81245,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &531
+ - &528
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -81735,7 +81306,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &532
+ - &529
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -81828,7 +81399,7 @@ paths:
color: red
headers:
Link: *56
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81845,9 +81416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81859,7 +81430,7 @@ paths:
type: array
items: *69
examples:
- default: &519
+ default: &516
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81877,9 +81448,9 @@ paths:
default: false
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81896,9 +81467,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -81959,10 +81530,10 @@ paths:
type: array
items: *69
examples:
- default: *519
- '301': *318
+ default: *516
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'422': *15
x-github:
githubCloudOnly: false
@@ -81979,9 +81550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -82043,10 +81614,10 @@ paths:
type: array
items: *69
examples:
- default: *519
- '301': *318
+ default: *516
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'422': *15
x-github:
githubCloudOnly: false
@@ -82063,15 +81634,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'204':
description: Response
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82090,9 +81661,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: name
in: path
required: true
@@ -82116,9 +81687,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82138,9 +81709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -82169,7 +81740,7 @@ paths:
'204':
description: Response
'403': *27
- '410': *509
+ '410': *506
'404': *6
'422': *15
x-github:
@@ -82187,9 +81758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'204':
description: Response
@@ -82219,9 +81790,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'200':
description: Response
@@ -82229,10 +81800,10 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82249,9 +81820,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- 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.
@@ -82277,13 +81848,13 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82301,9 +81872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82335,16 +81906,16 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -82366,10 +81937,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
- *513
+ - *510
responses:
'204':
description: Response
@@ -82398,9 +81969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82424,7 +81995,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -82457,9 +82028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -82471,11 +82042,11 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82503,9 +82074,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82534,14 +82105,14 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -82561,9 +82132,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82596,7 +82167,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
'403': *27
'404': *6
'422': *7
@@ -82618,9 +82189,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -82635,6 +82206,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *517
+ - *518
+ - *519
- *520
- *521
- *522
@@ -82645,9 +82219,6 @@ paths:
- *527
- *528
- *529
- - *530
- - *531
- - *532
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -82976,7 +82547,7 @@ paths:
type: string
comments:
type: array
- items: &553
+ items: &550
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -83214,7 +82785,7 @@ paths:
type: string
comments:
type: array
- items: *442
+ items: *439
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -83489,7 +83060,7 @@ paths:
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -83506,8 +83077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -83517,7 +83088,7 @@ paths:
application/json:
schema:
type: array
- items: &533
+ items: &530
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -83585,8 +83156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -83622,9 +83193,9 @@ paths:
description: Response
content:
application/json:
- schema: *533
+ schema: *530
examples:
- default: &534
+ default: &531
value:
id: 1
key: ssh-rsa AAA...
@@ -83658,9 +83229,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *314
- - *315
- - &535
+ - *311
+ - *312
+ - &532
name: key_id
description: The unique identifier of the key.
in: path
@@ -83672,9 +83243,9 @@ paths:
description: Response
content:
application/json:
- schema: *533
+ schema: *530
examples:
- default: *534
+ default: *531
'404': *6
x-github:
githubCloudOnly: false
@@ -83692,9 +83263,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *314
- - *315
- - *535
+ - *311
+ - *312
+ - *532
responses:
'204':
description: Response
@@ -83714,8 +83285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -83727,7 +83298,7 @@ paths:
type: array
items: *69
examples:
- default: *519
+ default: *516
headers:
Link: *56
'404': *6
@@ -83748,8 +83319,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -83787,7 +83358,7 @@ paths:
application/json:
schema: *69
examples:
- default: &536
+ default: &533
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -83819,8 +83390,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83833,7 +83404,7 @@ paths:
application/json:
schema: *69
examples:
- default: *536
+ default: *533
'404': *6
x-github:
githubCloudOnly: false
@@ -83850,8 +83421,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83916,8 +83487,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83943,8 +83514,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -83983,9 +83554,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *314
- - *315
- - *417
+ - *311
+ - *312
+ - *414
responses:
'200':
description: Response
@@ -84132,8 +83703,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84198,8 +83769,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84233,9 +83804,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: *537
+ default: *534
'204':
description: Response when already merged
'404':
@@ -84260,8 +83831,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -84358,8 +83929,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84401,7 +83972,7 @@ paths:
application/json:
schema: *252
examples:
- default: &538
+ default: &535
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -84460,9 +84031,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *314
- - *315
- - &539
+ - *311
+ - *312
+ - &536
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -84476,7 +84047,7 @@ paths:
application/json:
schema: *252
examples:
- default: *538
+ default: *535
'404': *6
x-github:
githubCloudOnly: false
@@ -84493,9 +84064,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
requestBody:
required: false
content:
@@ -84535,7 +84106,7 @@ paths:
application/json:
schema: *252
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84551,9 +84122,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
responses:
'204':
description: Response
@@ -84574,9 +84145,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
- *17
- *19
responses:
@@ -84588,7 +84159,7 @@ paths:
type: array
items: *69
examples:
- default: *519
+ default: *516
headers:
Link: *56
x-github:
@@ -84607,12 +84178,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *314
- - *315
- - *540
- - *541
+ - *311
+ - *312
+ - *537
+ - *538
- *76
- - *542
+ - *539
- *17
- *19
responses:
@@ -84624,7 +84195,7 @@ paths:
type: array
items: *96
examples:
- default: *543
+ default: *540
headers:
Link: *56
x-github:
@@ -84648,8 +84219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -84707,14 +84278,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &544
+ schema: &541
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -84858,7 +84429,7 @@ paths:
- custom_404
- public
examples:
- default: &545
+ default: &542
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -84899,8 +84470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84955,9 +84526,9 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
- default: *545
+ default: *542
'422': *15
'409': *49
x-github:
@@ -84980,8 +84551,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85081,8 +84652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -85108,8 +84679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -85119,7 +84690,7 @@ paths:
application/json:
schema:
type: array
- items: &546
+ items: &543
title: Page Build
description: Page Build
type: object
@@ -85211,8 +84782,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -85259,16 +84830,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
- default: &547
+ default: &544
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -85316,8 +84887,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: build_id
in: path
required: true
@@ -85328,9 +84899,9 @@ paths:
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
- default: *547
+ default: *544
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85350,8 +84921,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85459,9 +85030,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *314
- - *315
- - &548
+ - *311
+ - *312
+ - &545
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -85519,9 +85090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *314
- - *315
- - *548
+ - *311
+ - *312
+ - *545
responses:
'204': *176
'404': *6
@@ -85548,8 +85119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -85844,8 +85415,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Private vulnerability reporting status
@@ -85882,8 +85453,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'422': *14
@@ -85904,8 +85475,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'422': *14
@@ -85927,8 +85498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -85938,7 +85509,7 @@ paths:
type: array
items: *103
examples:
- default: *549
+ default: *546
'403': *27
'404': *6
x-github:
@@ -85960,8 +85531,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85977,7 +85548,7 @@ paths:
required:
- properties
examples:
- default: *550
+ default: *547
responses:
'204':
description: No Content when custom property values are successfully created
@@ -86015,8 +85586,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -86076,9 +85647,9 @@ paths:
application/json:
schema:
type: array
- items: *449
+ items: *446
examples:
- default: *551
+ default: *548
headers:
Link: *56
'304': *35
@@ -86110,8 +85681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -86178,7 +85749,7 @@ paths:
description: Response
content:
application/json:
- schema: &555
+ schema: &552
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -86418,7 +85989,7 @@ paths:
- review_comment
- self
author_association: *71
- auto_merge: *552
+ auto_merge: *549
draft:
description: Indicates whether or not the pull request is a draft.
type: boolean
@@ -86520,7 +86091,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &556
+ default: &553
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -87047,8 +86618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sort
in: query
required: false
@@ -87077,9 +86648,9 @@ paths:
application/json:
schema:
type: array
- items: *553
+ items: *550
examples:
- default: &558
+ default: &555
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -87156,17 +86727,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: &554
+ default: &551
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -87241,8 +86812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -87265,9 +86836,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: *554
+ default: *551
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87283,8 +86854,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -87306,8 +86877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -87334,9 +86905,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -87357,8 +86928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -87391,16 +86962,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -87422,10 +86993,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - *513
+ - *510
responses:
'204':
description: Response
@@ -87468,9 +87039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *314
- - *315
- - &557
+ - *311
+ - *312
+ - &554
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -87483,9 +87054,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *556
+ default: *553
'304': *35
'404': *6
'406':
@@ -87520,9 +87091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -87564,9 +87135,9 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *556
+ default: *553
'422': *15
'403': *27
x-github:
@@ -87588,9 +87159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -87653,7 +87224,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -87661,7 +87232,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -87691,9 +87262,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *93
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -87714,9 +87285,9 @@ paths:
application/json:
schema:
type: array
- items: *553
+ items: *550
examples:
- default: *558
+ default: *555
headers:
Link: *56
x-github:
@@ -87749,9 +87320,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -87857,7 +87428,7 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
example-for-a-multi-line-comment:
value:
@@ -87945,9 +87516,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *85
requestBody:
required: true
@@ -87970,7 +87541,7 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
default:
value:
@@ -88056,9 +87627,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -88068,9 +87639,9 @@ paths:
application/json:
schema:
type: array
- items: *445
+ items: *442
examples:
- default: *559
+ default: *556
headers:
Link: *56
x-github:
@@ -88100,9 +87671,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -88112,7 +87683,7 @@ paths:
application/json:
schema:
type: array
- items: *456
+ items: *453
examples:
default:
value:
@@ -88150,9 +87721,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
responses:
'204':
description: Response if pull request has been merged
@@ -88175,9 +87746,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -88289,9 +87860,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
responses:
'200':
description: Response
@@ -88366,9 +87937,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -88405,7 +87976,7 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -88941,9 +88512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -88977,7 +88548,7 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -89482,9 +89053,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -89494,7 +89065,7 @@ paths:
application/json:
schema:
type: array
- items: &560
+ items: &557
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -89650,9 +89221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -89742,9 +89313,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: &562
+ default: &559
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -89807,10 +89378,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - &561
+ - *311
+ - *312
+ - *554
+ - &558
name: review_id
description: The unique identifier of the review.
in: path
@@ -89822,9 +89393,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: &563
+ default: &560
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -89883,10 +89454,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -89909,7 +89480,7 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
default:
value:
@@ -89971,18 +89542,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
responses:
'200':
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *562
+ default: *559
'422': *7
'404': *6
x-github:
@@ -90009,10 +89580,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
- *17
- *19
responses:
@@ -90270,10 +89841,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -90302,7 +89873,7 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
default:
value:
@@ -90365,10 +89936,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -90403,9 +89974,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *563
+ default: *560
'404': *6
'422': *7
'403': *27
@@ -90427,9 +89998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -90493,8 +90064,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -90507,9 +90078,9 @@ paths:
description: Response
content:
application/json:
- schema: *564
+ schema: *561
examples:
- default: &565
+ default: &562
value:
type: file
encoding: base64
@@ -90551,8 +90122,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: dir
description: The alternate path to look for a README file
in: path
@@ -90572,9 +90143,9 @@ paths:
description: Response
content:
application/json:
- schema: *564
+ schema: *561
examples:
- default: *565
+ default: *562
'404': *6
'422': *15
x-github:
@@ -90596,8 +90167,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -90607,7 +90178,7 @@ paths:
application/json:
schema:
type: array
- items: *566
+ items: *563
examples:
default:
value:
@@ -90701,8 +90272,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -90778,9 +90349,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: &570
+ default: &567
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -90885,9 +90456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *314
- - *315
- - &568
+ - *311
+ - *312
+ - &565
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -90899,9 +90470,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: &569
+ default: &566
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
@@ -90936,7 +90507,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *458
+ '302': *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -90952,9 +90523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *314
- - *315
- - *568
+ - *311
+ - *312
+ - *565
requestBody:
required: false
content:
@@ -90983,9 +90554,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *569
+ default: *566
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91001,9 +90572,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *314
- - *315
- - *568
+ - *311
+ - *312
+ - *565
responses:
'204':
description: Response
@@ -91027,8 +90598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -91114,16 +90685,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91140,8 +90711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tag
description: tag parameter
in: path
@@ -91154,9 +90725,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'404': *6
x-github:
githubCloudOnly: false
@@ -91178,9 +90749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *314
- - *315
- - &571
+ - *311
+ - *312
+ - &568
name: release_id
description: The unique identifier of the release.
in: path
@@ -91194,9 +90765,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: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'401':
description: Unauthorized
x-github:
@@ -91214,9 +90785,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
requestBody:
required: false
content:
@@ -91280,9 +90851,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -91303,9 +90874,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
responses:
'204':
description: Response
@@ -91325,9 +90896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- *17
- *19
responses:
@@ -91337,7 +90908,7 @@ paths:
application/json:
schema:
type: array
- items: *567
+ items: *564
examples:
default:
value:
@@ -91418,9 +90989,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:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- name: name
in: query
required: true
@@ -91446,7 +91017,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *567
+ schema: *564
examples:
response-for-successful-upload:
value:
@@ -91501,9 +91072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- 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.
@@ -91527,9 +91098,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -91550,9 +91121,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
requestBody:
required: true
content:
@@ -91582,16 +91153,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -91613,10 +91184,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *314
- - *315
- - *571
- - *513
+ - *311
+ - *312
+ - *568
+ - *510
responses:
'204':
description: Response
@@ -91640,9 +91211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
- *17
- *19
responses:
@@ -91659,7 +91230,7 @@ paths:
oneOf:
- allOf:
- *271
- - &572
+ - &569
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -91680,67 +91251,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *272
- - *572
+ - *569
- allOf:
- *273
- - *572
+ - *569
- allOf:
- *274
- - *572
+ - *569
- allOf:
- - *573
- - *572
+ - *570
+ - *569
- allOf:
- *275
- - *572
+ - *569
- allOf:
- *276
- - *572
+ - *569
- allOf:
- *277
- - *572
+ - *569
- allOf:
- *278
- - *572
+ - *569
- allOf:
- *279
- - *572
+ - *569
- allOf:
- *280
- - *572
+ - *569
- allOf:
- *281
- - *572
+ - *569
- allOf:
- *282
- - *572
+ - *569
- allOf:
- *283
- - *572
+ - *569
- allOf:
- *284
- - *572
+ - *569
- allOf:
- *285
- - *572
+ - *569
- allOf:
- *286
- - *572
+ - *569
- allOf:
- *287
- - *572
+ - *569
- allOf:
- *288
- - *572
+ - *569
- allOf:
- *289
- - *572
+ - *569
- allOf:
- *290
- - *572
+ - *569
- allOf:
- *291
- - *572
+ - *569
examples:
default:
value:
@@ -91779,8 +91350,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- name: includes_parents
@@ -91791,7 +91362,7 @@ paths:
schema:
type: boolean
default: true
- - *574
+ - *571
responses:
'200':
description: Response
@@ -91846,8 +91417,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
description: Request body
required: true
@@ -91876,7 +91447,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *575
+ items: *572
required:
- name
- enforcement
@@ -91909,7 +91480,7 @@ paths:
application/json:
schema: *292
examples:
- default: &585
+ default: &582
value:
id: 42
name: super cool ruleset
@@ -91956,12 +91527,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *573
+ - *574
+ - *575
- *576
- - *577
- - *578
- - *579
- *17
- *19
responses:
@@ -91969,9 +91540,9 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
- default: *581
+ default: *578
'404': *6
'500': *104
x-github:
@@ -91992,17 +91563,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *314
- - *315
- - *582
+ - *311
+ - *312
+ - *579
responses:
'200':
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
- default: *584
+ default: *581
'404': *6
'500': *104
x-github:
@@ -92030,8 +91601,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92053,7 +91624,7 @@ paths:
application/json:
schema: *292
examples:
- default: *585
+ default: *582
'404': *6
'500': *104
put:
@@ -92071,8 +91642,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92106,7 +91677,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *575
+ items: *572
examples:
default:
value:
@@ -92136,7 +91707,7 @@ paths:
application/json:
schema: *292
examples:
- default: *585
+ default: *582
'404': *6
'500': *104
delete:
@@ -92154,8 +91725,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92178,8 +91749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- name: ruleset_id
@@ -92197,7 +91768,7 @@ paths:
type: array
items: *295
examples:
- default: *586
+ default: *583
'404': *6
'500': *104
x-github:
@@ -92216,8 +91787,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92235,7 +91806,7 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
default:
value:
@@ -92290,22 +91861,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *585
+ - *586
+ - *587
- *588
- *589
- - *590
- - *591
- - *592
- *50
- *19
- *17
+ - *590
+ - *591
+ - *592
- *593
- *594
- *595
- - *596
- - *597
- - *598
responses:
'200':
description: Response
@@ -92313,7 +91884,7 @@ paths:
application/json:
schema:
type: array
- items: &602
+ items: &599
type: object
properties:
number: *162
@@ -92329,8 +91900,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *599
- resolution: *600
+ state: *596
+ resolution: *597
resolved_at:
type:
- string
@@ -92424,7 +91995,7 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - *601
+ - *598
has_more_locations:
type: boolean
description: A boolean value representing whether or not the
@@ -92569,16 +92140,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
- - *598
+ - *311
+ - *312
+ - *408
+ - *595
responses:
'200':
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
default:
value:
@@ -92632,9 +92203,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: true
content:
@@ -92642,8 +92213,8 @@ paths:
schema:
type: object
properties:
- state: *599
- resolution: *600
+ state: *596
+ resolution: *597
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -92679,7 +92250,7 @@ paths:
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
default:
value:
@@ -92774,9 +92345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
- *19
- *17
responses:
@@ -92787,7 +92358,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &756
+ items: &751
type: object
properties:
type:
@@ -92814,6 +92385,9 @@ paths:
- commit
details:
oneOf:
+ - *600
+ - *601
+ - *602
- *603
- *604
- *605
@@ -92824,9 +92398,6 @@ paths:
- *610
- *611
- *612
- - *613
- - *614
- - *615
examples:
default:
value:
@@ -92912,8 +92483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -92921,14 +92492,14 @@ paths:
schema:
type: object
properties:
- reason: &617
+ reason: &614
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *616
+ placeholder_id: *613
required:
- reason
- placeholder_id
@@ -92945,7 +92516,7 @@ paths:
schema:
type: object
properties:
- reason: *617
+ reason: *614
expire_at:
type:
- string
@@ -92992,8 +92563,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -93008,7 +92579,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &618
+ items: &615
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -93036,15 +92607,15 @@ paths:
the scan is pending
pattern_update_scans:
type: array
- items: *618
+ items: *615
backfill_scans:
type: array
- items: *618
+ items: *615
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *618
+ - *615
- type: object
properties:
pattern_name:
@@ -93114,8 +92685,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *50
- name: sort
description: The property to sort the results by.
@@ -93159,9 +92730,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *616
examples:
- default: *620
+ default: *617
'400': *14
'404': *6
x-github:
@@ -93184,8 +92755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -93355,9 +92926,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: &622
+ default: &619
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -93590,8 +93161,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -93704,7 +93275,7 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
default:
value:
@@ -93851,17 +93422,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'200':
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *622
+ default: *619
'403': *27
'404': *6
x-github:
@@ -93885,9 +93456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
requestBody:
required: true
content:
@@ -94058,10 +93629,10 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *622
- add_credit: *622
+ default: *619
+ add_credit: *619
'403': *27
'404': *6
'422':
@@ -94099,9 +93670,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:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'202': *37
'400': *14
@@ -94128,17 +93699,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'202':
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
'400': *14
'422': *15
'403': *27
@@ -94164,8 +93735,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -94261,8 +93832,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -94271,7 +93842,7 @@ paths:
application/json:
schema:
type: array
- items: &623
+ items: &620
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -94304,8 +93875,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -94383,8 +93954,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -94478,8 +94049,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -94633,8 +94204,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -94644,7 +94215,7 @@ paths:
application/json:
schema:
type: array
- items: *623
+ items: *620
examples:
default:
value:
@@ -94677,8 +94248,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
in: path
required: true
@@ -94734,7 +94305,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
default:
value:
@@ -94788,8 +94359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -94821,14 +94392,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &625
+ schema: &622
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -94901,8 +94472,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -94928,7 +94499,7 @@ paths:
description: Response
content:
application/json:
- schema: *625
+ schema: *622
examples:
default:
value:
@@ -94955,8 +94526,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -94976,8 +94547,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -95059,8 +94630,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95068,7 +94639,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
title: Tag protection
description: Tag protection
type: object
@@ -95125,8 +94696,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -95149,7 +94720,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -95180,8 +94751,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:
- - *314
- - *315
+ - *311
+ - *312
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -95218,8 +94789,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
in: path
required: true
@@ -95255,8 +94826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -95288,8 +94859,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
responses:
@@ -95297,7 +94868,7 @@ paths:
description: Response
content:
application/json:
- schema: &627
+ schema: &624
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -95309,7 +94880,7 @@ paths:
required:
- names
examples:
- default: &628
+ default: &625
value:
names:
- octocat
@@ -95332,8 +94903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -95364,9 +94935,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
'404': *6
'422': *7
x-github:
@@ -95387,9 +94958,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *314
- - *315
- - &629
+ - *311
+ - *312
+ - &626
name: per
description: The time frame to display results for.
in: query
@@ -95420,7 +94991,7 @@ paths:
- 128
clones:
type: array
- items: &630
+ items: &627
title: Traffic
type: object
properties:
@@ -95508,8 +95079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95604,8 +95175,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95669,9 +95240,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *314
- - *315
- - *629
+ - *311
+ - *312
+ - *626
responses:
'200':
description: Response
@@ -95692,7 +95263,7 @@ paths:
- 3782
views:
type: array
- items: *630
+ items: *627
required:
- uniques
- count
@@ -95770,8 +95341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -96045,8 +95616,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -96069,8 +95640,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -96092,8 +95663,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -96119,8 +95690,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
in: path
required: true
@@ -96212,9 +95783,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -96463,7 +96034,7 @@ paths:
examples:
- 73..77
- 77..78
- text_matches: &631
+ text_matches: &628
title: Search Result Text Matches
type: array
items:
@@ -96626,7 +96197,7 @@ paths:
enum:
- author-date
- committer-date
- - &632
+ - &629
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
@@ -96695,7 +96266,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
comment_count:
type: integer
message:
@@ -96714,7 +96285,7 @@ paths:
url:
type: string
format: uri
- verification: *495
+ verification: *492
required:
- author
- committer
@@ -96729,7 +96300,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
parents:
type: array
items:
@@ -96746,7 +96317,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *631
+ text_matches: *628
required:
- sha
- node_id
@@ -96938,7 +96509,7 @@ paths:
- interactions
- created
- updated
- - *632
+ - *629
- *17
- *19
- name: advanced_search
@@ -97035,11 +96606,11 @@ paths:
type:
- string
- 'null'
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
type: string
state_reason:
@@ -97067,7 +96638,7 @@ paths:
- string
- 'null'
format: date-time
- text_matches: *631
+ text_matches: *628
pull_request:
type: object
properties:
@@ -97290,7 +96861,7 @@ paths:
enum:
- created
- updated
- - *632
+ - *629
- *17
- *19
responses:
@@ -97335,7 +96906,7 @@ paths:
- 'null'
score:
type: number
- text_matches: *631
+ text_matches: *628
required:
- id
- node_id
@@ -97420,7 +96991,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *632
+ - *629
- *17
- *19
responses:
@@ -97657,7 +97228,7 @@ paths:
- admin
- pull
- push
- text_matches: *631
+ text_matches: *628
temp_clone_token:
type: string
allow_merge_commit:
@@ -97965,7 +97536,7 @@ paths:
- string
- 'null'
format: uri
- text_matches: *631
+ text_matches: *628
related:
type:
- array
@@ -98158,7 +97729,7 @@ paths:
- followers
- repositories
- joined
- - *632
+ - *629
- *17
- *19
responses:
@@ -98268,7 +97839,7 @@ paths:
type:
- boolean
- 'null'
- text_matches: *631
+ text_matches: *628
blog:
type:
- string
@@ -98350,7 +97921,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &636
+ - &633
name: team_id
description: The unique identifier of the team.
in: path
@@ -98391,7 +97962,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *636
+ - *633
requestBody:
required: true
content:
@@ -98492,7 +98063,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *636
+ - *633
responses:
'204':
description: Response
@@ -98523,7 +98094,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *636
+ - *633
- *50
- *17
- *19
@@ -98536,7 +98107,7 @@ paths:
type: array
items: *307
examples:
- default: *637
+ default: *634
headers:
Link: *56
x-github:
@@ -98565,7 +98136,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *636
+ - *633
requestBody:
required: true
content:
@@ -98628,7 +98199,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
responses:
'200':
@@ -98662,7 +98233,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
requestBody:
required: false
@@ -98688,7 +98259,7 @@ paths:
application/json:
schema: *307
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98713,7 +98284,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
responses:
'204':
@@ -98726,218 +98297,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:
- - *636
- - *309
- - *50
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *310
- examples:
- default: *639
- headers:
- Link: *56
- 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:
- - *636
- - *309
- 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: *310
- examples:
- default: *311
- 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:
- - *636
- - *309
- - *312
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *310
- examples:
- default: *311
- 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:
- - *636
- - *309
- - *312
- 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: *310
- examples:
- default: *640
- 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:
- - *636
- - *309
- - *312
- 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)
@@ -98953,7 +98312,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -98991,7 +98350,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *636
+ - *633
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -99042,7 +98401,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99079,7 +98438,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99119,7 +98478,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99156,16 +98515,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'200':
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-user-is-a-team-maintainer: *641
+ response-if-user-is-a-team-maintainer: *636
'404': *6
x-github:
githubCloudOnly: false
@@ -99198,7 +98557,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
requestBody:
required: false
@@ -99224,9 +98583,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-users-membership-with-team-is-now-pending: *642
+ response-if-users-membership-with-team-is-now-pending: *637
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -99260,7 +98619,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99288,7 +98647,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -99330,15 +98689,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *643
+ schema: *638
examples:
alternative-response-with-extra-repository-information:
value:
@@ -99489,9 +98848,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -99541,9 +98900,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -99568,7 +98927,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -99580,7 +98939,7 @@ paths:
type: array
items: *180
examples:
- response-if-child-teams-exist: *644
+ response-if-child-teams-exist: *639
headers:
Link: *56
'404': *6
@@ -99613,7 +98972,7 @@ paths:
application/json:
schema:
oneOf:
- - &646
+ - &641
title: Private User
description: Private User
type: object
@@ -99863,7 +99222,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *645
+ - *640
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -100023,7 +99382,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *641
examples:
default:
value:
@@ -100369,7 +99728,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -100377,7 +99736,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -100421,7 +99780,7 @@ paths:
type: integer
secrets:
type: array
- items: &647
+ items: &642
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -100463,7 +99822,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *436
+ default: *433
headers:
Link: *56
x-github:
@@ -100541,7 +99900,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *642
examples:
default:
value:
@@ -100687,7 +100046,7 @@ paths:
type: array
items: *144
examples:
- default: *648
+ default: *643
'401': *23
'403': *27
'404': *6
@@ -100839,7 +100198,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'304': *35
'500': *104
'401': *23
@@ -100897,7 +100256,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -100954,7 +100313,7 @@ paths:
description: Response
content:
application/json:
- schema: &649
+ schema: &644
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -101007,7 +100366,7 @@ paths:
examples:
- https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &650
+ default: &645
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -101052,9 +100411,9 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *644
examples:
- default: *650
+ default: *645
'404': *6
x-github:
githubCloudOnly: false
@@ -101091,9 +100450,9 @@ paths:
type: integer
machines:
type: array
- items: *435
+ items: *432
examples:
- default: *651
+ default: *646
'304': *35
'500': *104
'401': *23
@@ -101178,11 +100537,11 @@ paths:
- 26a7c758-7299-4a73-b978-5a92a7ae98a0
owner: *4
billable_owner: *4
- repository: *317
+ repository: *314
machine:
anyOf:
- type: 'null'
- - *435
+ - *432
devcontainer_path:
description: Path to devcontainer.json from repo root used to
create Codespace.
@@ -101987,7 +101346,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'304': *35
'500': *104
'400': *14
@@ -102027,7 +101386,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'500': *104
'401': *23
'403': *27
@@ -102059,7 +101418,7 @@ paths:
type: array
items: *233
examples:
- default: &662
+ default: &657
value:
- id: 197
name: hello_docker
@@ -102160,7 +101519,7 @@ paths:
application/json:
schema:
type: array
- items: &652
+ items: &647
title: Email
description: Email
type: object
@@ -102230,9 +101589,9 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
- default: &664
+ default: &659
value:
- email: octocat@github.com
verified: true
@@ -102309,7 +101668,7 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
default:
value:
@@ -102567,7 +101926,7 @@ paths:
application/json:
schema:
type: array
- items: &653
+ items: &648
title: GPG Key
description: A unique encryption key
type: object
@@ -102712,7 +102071,7 @@ paths:
- subkeys
- revoked
examples:
- default: &678
+ default: &673
value:
- id: 3
name: Octocat's GPG Key
@@ -102797,9 +102156,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *648
examples:
- default: &654
+ default: &649
value:
id: 3
name: Octocat's GPG Key
@@ -102856,7 +102215,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &655
+ - &650
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -102868,9 +102227,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *648
examples:
- default: *654
+ default: *649
'404': *6
'304': *35
'403': *27
@@ -102893,7 +102252,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *655
+ - *650
responses:
'204':
description: Response
@@ -103198,7 +102557,7 @@ paths:
required: true
content:
application/json:
- schema: *506
+ schema: *503
examples:
default:
value:
@@ -103348,7 +102707,7 @@ paths:
application/json:
schema:
type: array
- items: &656
+ items: &651
title: Key
description: Key
type: object
@@ -103451,9 +102810,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *651
examples:
- default: &657
+ default: &652
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -103486,15 +102845,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *535
+ - *532
responses:
'200':
description: Response
content:
application/json:
- schema: *656
+ schema: *651
examples:
- default: *657
+ default: *652
'404': *6
'304': *35
'403': *27
@@ -103517,7 +102876,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *535
+ - *532
responses:
'204':
description: Response
@@ -103550,7 +102909,7 @@ paths:
application/json:
schema:
type: array
- items: &658
+ items: &653
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -103629,7 +102988,7 @@ paths:
- account
- plan
examples:
- default: &659
+ default: &654
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -103691,9 +103050,9 @@ paths:
application/json:
schema:
type: array
- items: *658
+ items: *653
examples:
- default: *659
+ default: *654
headers:
Link: *56
'304': *35
@@ -104711,7 +104070,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *228
- - *660
+ - *655
responses:
'204':
description: Response
@@ -104826,7 +104185,7 @@ paths:
- docker
- nuget
- container
- - *661
+ - *656
- *19
- *17
responses:
@@ -104838,8 +104197,8 @@ paths:
type: array
items: *233
examples:
- default: *662
- '400': *663
+ default: *657
+ '400': *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104868,7 +104227,7 @@ paths:
application/json:
schema: *233
examples:
- default: &679
+ default: &674
value:
id: 40201
name: octo-name
@@ -105230,9 +104589,9 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
- default: *664
+ default: *659
headers:
Link: *56
'304': *35
@@ -105345,7 +104704,7 @@ paths:
type: array
items: *68
examples:
- default: &671
+ default: &666
summary: Default response
value:
- id: 1296269
@@ -105663,9 +105022,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -105703,9 +105062,9 @@ paths:
application/json:
schema:
type: array
- items: *508
+ items: *505
examples:
- default: *665
+ default: *660
headers:
Link: *56
'304': *35
@@ -105784,7 +105143,7 @@ paths:
application/json:
schema:
type: array
- items: &666
+ items: &661
title: Social account
description: Social media account
type: object
@@ -105801,7 +105160,7 @@ paths:
- provider
- url
examples:
- default: &667
+ default: &662
value:
- provider: twitter
url: https://twitter.com/github
@@ -105864,9 +105223,9 @@ paths:
application/json:
schema:
type: array
- items: *666
+ items: *661
examples:
- default: *667
+ default: *662
'422': *15
'304': *35
'404': *6
@@ -105954,7 +105313,7 @@ paths:
application/json:
schema:
type: array
- items: &668
+ items: &663
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -105974,7 +105333,7 @@ paths:
- title
- created_at
examples:
- default: &697
+ default: &692
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -106039,9 +105398,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: &669
+ default: &664
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -106071,7 +105430,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:
- - &670
+ - &665
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -106083,9 +105442,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: *669
+ default: *664
'404': *6
'304': *35
'403': *27
@@ -106108,7 +105467,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:
- - *670
+ - *665
responses:
'204':
description: Response
@@ -106137,7 +105496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &698
+ - &693
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
@@ -106162,11 +105521,11 @@ paths:
type: array
items: *68
examples:
- default-response: *671
+ default-response: *666
application/vnd.github.v3.star+json:
schema:
type: array
- items: &699
+ items: &694
title: Starred Repository
description: Starred Repository
type: object
@@ -106322,8 +105681,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response if this repository is starred by you
@@ -106351,8 +105710,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -106376,8 +105735,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -106535,10 +105894,10 @@ paths:
application/json:
schema:
oneOf:
- - *646
- - *645
+ - *641
+ - *640
examples:
- default-response: &673
+ default-response: &668
summary: Default response
value:
login: octocat
@@ -106573,7 +105932,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &674
+ response-with-git-hub-plan-information: &669
summary: Response with GitHub plan information
value:
login: octocat
@@ -106695,7 +106054,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *672
+ - *667
- *17
responses:
'200':
@@ -106744,11 +106103,11 @@ paths:
application/json:
schema:
oneOf:
- - *646
- - *645
+ - *641
+ - *640
examples:
- default-response: *673
- response-with-git-hub-plan-information: *674
+ default-response: *668
+ response-with-git-hub-plan-information: *669
'404': *6
x-github:
githubCloudOnly: false
@@ -106798,8 +106157,8 @@ paths:
required:
- subject_digests
examples:
- default: *675
- withPredicateType: *676
+ default: *670
+ withPredicateType: *671
responses:
'200':
description: Response
@@ -106853,7 +106212,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *677
+ default: *672
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -107058,7 +106417,7 @@ paths:
initiator:
type: string
examples:
- default: *375
+ default: *372
'201':
description: Response
content:
@@ -107099,7 +106458,7 @@ paths:
type: array
items: *233
examples:
- default: *662
+ default: *657
'403': *27
'401': *23
x-github:
@@ -107483,9 +106842,9 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *648
examples:
- default: *678
+ default: *673
headers:
Link: *56
x-github:
@@ -107589,7 +106948,7 @@ paths:
application/json:
schema: *20
examples:
- default: *505
+ default: *502
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -107714,7 +107073,7 @@ paths:
- docker
- nuget
- container
- - *661
+ - *656
- *61
- *19
- *17
@@ -107727,10 +107086,10 @@ paths:
type: array
items: *233
examples:
- default: *662
+ default: *657
'403': *27
'401': *23
- '400': *663
+ '400': *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -107760,7 +107119,7 @@ paths:
application/json:
schema: *233
examples:
- default: *679
+ default: *674
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -108109,7 +107468,7 @@ paths:
type: array
items: *254
examples:
- default: *680
+ default: *675
headers:
Link: *56
'304': *35
@@ -108169,7 +107528,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *681
+ items: *676
required:
- name
- data_type
@@ -108185,7 +107544,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *682
+ iteration_configuration: *677
required:
- name
- data_type
@@ -108207,8 +107566,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *683
- iteration_field: *684
+ single_select_field: *678
+ iteration_field: *679
responses:
'201':
description: Response
@@ -108216,11 +107575,11 @@ paths:
application/json:
schema: *254
examples:
- text_field: *685
- number_field: *686
- date_field: *687
- single_select_field: *688
- iteration_field: *689
+ text_field: *680
+ number_field: *681
+ date_field: *682
+ single_select_field: *683
+ iteration_field: *684
'304': *35
'403': *27
'401': *23
@@ -108242,7 +107601,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *251
- - *690
+ - *685
- *61
responses:
'200':
@@ -108251,7 +107610,7 @@ paths:
application/json:
schema: *254
examples:
- default: *691
+ default: *686
headers:
Link: *56
'304': *35
@@ -108604,7 +107963,7 @@ paths:
parameters:
- *251
- *61
- - *692
+ - *687
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -108879,7 +108238,7 @@ paths:
- *107
- *109
- *108
- - *693
+ - *688
- *110
responses:
'200':
@@ -109010,7 +108369,7 @@ paths:
parameters:
- *61
- *107
- - *694
+ - *689
- *108
responses:
'200':
@@ -109109,9 +108468,9 @@ paths:
- *107
- *109
- *108
- - *695
+ - *690
- *110
- - *696
+ - *691
responses:
'200':
description: Response when getting a billing usage summary
@@ -109245,9 +108604,9 @@ paths:
application/json:
schema:
type: array
- items: *666
+ items: *661
examples:
- default: *667
+ default: *662
headers:
Link: *56
x-github:
@@ -109277,9 +108636,9 @@ paths:
application/json:
schema:
type: array
- items: *668
+ items: *663
examples:
- default: *697
+ default: *692
headers:
Link: *56
x-github:
@@ -109304,7 +108663,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *61
- - *698
+ - *693
- *50
- *17
- *19
@@ -109316,11 +108675,11 @@ paths:
schema:
anyOf:
- type: array
- items: *699
+ items: *694
- type: array
items: *68
examples:
- default-response: *671
+ default-response: *666
headers:
Link: *56
x-github:
@@ -109480,7 +108839,7 @@ webhooks:
type: string
enum:
- disabled
- enterprise: &700
+ enterprise: &695
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -109549,7 +108908,7 @@ webhooks:
- created_at
- updated_at
- avatar_url
- installation: &701
+ installation: &696
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -109570,7 +108929,7 @@ webhooks:
required:
- id
- node_id
- organization: &702
+ organization: &697
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -109643,7 +109002,7 @@ webhooks:
- public_members_url
- avatar_url
- description
- repository: &703
+ repository: &698
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
@@ -110556,10 +109915,10 @@ webhooks:
type: string
enum:
- enabled
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -110635,11 +109994,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: &704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: &699
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)
@@ -110862,11 +110221,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: *704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: *699
sender: *4
required:
- action
@@ -111054,11 +110413,11 @@ webhooks:
- everyone
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: *704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: *699
sender: *4
required:
- action
@@ -111142,7 +110501,7 @@ webhooks:
type: string
enum:
- completed
- check_run: &706
+ check_run: &701
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -111252,7 +110611,7 @@ webhooks:
-
examples:
- neutral
- deployment: *705
+ deployment: *700
details_url:
type: string
examples:
@@ -111350,10 +110709,10 @@ webhooks:
- output
- app
- pull_requests
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -111746,11 +111105,11 @@ webhooks:
type: string
enum:
- created
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -112146,11 +111505,11 @@ webhooks:
type: string
enum:
- requested_action
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
requested_action:
description: The action requested by the user.
type: object
@@ -112555,11 +111914,11 @@ webhooks:
type: string
enum:
- rerequested
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -113551,10 +112910,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -114263,10 +113622,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -114969,10 +114328,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -115141,7 +114500,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -115293,20 +114652,20 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &707
+ commit_oid: &702
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: *700
- installation: *701
- organization: *702
- ref: &708
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: &703
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: *703
+ repository: *698
sender: *4
required:
- action
@@ -115473,7 +114832,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -115714,12 +115073,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -115817,7 +115176,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116002,12 +115361,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -116176,7 +115535,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -116353,12 +115712,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -116459,7 +115818,7 @@ webhooks:
type:
- object
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116648,9 +116007,9 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
@@ -116658,7 +116017,7 @@ webhooks:
type:
- string
- 'null'
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -116757,7 +116116,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116904,12 +116263,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -117078,7 +116437,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -117230,10 +116589,10 @@ webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -117493,10 +116852,10 @@ webhooks:
- updated_at
- author_association
- body
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -117577,18 +116936,18 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *702
- pusher_type: &709
+ organization: *697
+ pusher_type: &704
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &710
+ ref: &705
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -117598,7 +116957,7 @@ webhooks:
enum:
- tag
- branch
- repository: *703
+ repository: *698
sender: *4
required:
- ref
@@ -117681,9 +117040,9 @@ webhooks:
enum:
- created
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117768,9 +117127,9 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117848,9 +117207,9 @@ webhooks:
enum:
- promote_to_enterprise
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117928,9 +117287,9 @@ webhooks:
enum:
- updated
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -118007,10 +117366,10 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- repository: *703
- organization: *702
+ enterprise: *695
+ installation: *696
+ repository: *698
+ organization: *697
sender: *4
new_property_values:
type: array
@@ -118095,18 +117454,18 @@ webhooks:
title: delete event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- pusher_type: *709
- ref: *710
+ enterprise: *695
+ installation: *696
+ organization: *697
+ pusher_type: *704
+ ref: *705
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *703
+ repository: *698
sender: *4
required:
- ref
@@ -118190,11 +117549,11 @@ webhooks:
type: string
enum:
- auto_dismissed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118278,11 +117637,11 @@ webhooks:
type: string
enum:
- auto_reopened
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118366,11 +117725,11 @@ webhooks:
type: string
enum:
- created
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118452,11 +117811,11 @@ webhooks:
type: string
enum:
- dismissed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118538,11 +117897,11 @@ webhooks:
type: string
enum:
- fixed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118625,11 +117984,11 @@ webhooks:
type: string
enum:
- reintroduced
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118711,11 +118070,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118792,9 +118151,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- key: &711
+ enterprise: *695
+ installation: *696
+ key: &706
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -118832,8 +118191,8 @@ webhooks:
- verified
- created_at
- read_only
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -118910,11 +118269,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- key: *711
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ key: *706
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -119486,12 +118845,12 @@ webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: &715
+ workflow: &710
title: Workflow
type:
- object
@@ -120229,13 +119588,13 @@ webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *470
+ deployment: *467
pull_requests:
type: array
- items: *555
- repository: *703
- organization: *702
- installation: *701
+ items: *552
+ repository: *698
+ organization: *697
+ installation: *696
sender: *4
responses:
'200':
@@ -120306,7 +119665,7 @@ webhooks:
type: string
enum:
- approved
- approver: &712
+ approver: &707
type: object
properties:
avatar_url:
@@ -120349,11 +119708,11 @@ webhooks:
type: string
comment:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- reviewers: &713
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ reviewers: &708
type: array
items:
type: object
@@ -120434,7 +119793,7 @@ webhooks:
sender: *4
since:
type: string
- workflow_job_run: &714
+ workflow_job_run: &709
type: object
properties:
conclusion:
@@ -121180,18 +120539,18 @@ webhooks:
type: string
enum:
- rejected
- approver: *712
+ approver: *707
comment:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- reviewers: *713
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ reviewers: *708
sender: *4
since:
type: string
- workflow_job_run: *714
+ workflow_job_run: *709
workflow_job_runs:
type: array
items:
@@ -121908,13 +121267,13 @@ webhooks:
type: string
enum:
- requested
- enterprise: *700
+ enterprise: *695
environment:
type: string
- installation: *701
- organization: *702
- repository: *703
- requestor: &720
+ installation: *696
+ organization: *697
+ repository: *698
+ requestor: &715
title: User
type:
- object
@@ -123857,12 +123216,12 @@ webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Deployment Workflow Run
type:
@@ -124553,7 +123912,7 @@ webhooks:
type: string
enum:
- answered
- answer: &718
+ answer: &713
type: object
properties:
author_association:
@@ -124713,11 +124072,11 @@ webhooks:
- created_at
- updated_at
- body
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -124844,11 +124203,11 @@ webhooks:
- from
required:
- category
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -124931,11 +124290,11 @@ webhooks:
type: string
enum:
- closed
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125017,7 +124376,7 @@ webhooks:
type: string
enum:
- created
- comment: &717
+ comment: &712
type: object
properties:
author_association:
@@ -125177,11 +124536,11 @@ webhooks:
- updated_at
- body
- reactions
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125264,12 +124623,12 @@ webhooks:
type: string
enum:
- deleted
- comment: *717
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ comment: *712
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125364,12 +124723,12 @@ webhooks:
- from
required:
- body
- comment: *717
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ comment: *712
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125453,11 +124812,11 @@ webhooks:
type: string
enum:
- created
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125539,11 +124898,11 @@ webhooks:
type: string
enum:
- deleted
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125643,11 +125002,11 @@ webhooks:
type: string
required:
- from
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125729,10 +125088,10 @@ webhooks:
type: string
enum:
- labeled
- discussion: *716
- enterprise: *700
- installation: *701
- label: &719
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ label: &714
title: Label
type: object
properties:
@@ -125765,8 +125124,8 @@ webhooks:
- color
- default
- description
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125849,11 +125208,11 @@ webhooks:
type: string
enum:
- locked
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125935,11 +125294,11 @@ webhooks:
type: string
enum:
- pinned
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126021,11 +125380,11 @@ webhooks:
type: string
enum:
- reopened
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126110,16 +125469,16 @@ webhooks:
changes:
type: object
properties:
- new_discussion: *716
- new_repository: *703
+ new_discussion: *711
+ new_repository: *698
required:
- new_discussion
- new_repository
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126202,10 +125561,10 @@ webhooks:
type: string
enum:
- unanswered
- discussion: *716
- old_answer: *718
- organization: *702
- repository: *703
+ discussion: *711
+ old_answer: *713
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126287,12 +125646,12 @@ webhooks:
type: string
enum:
- unlabeled
- discussion: *716
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126375,11 +125734,11 @@ webhooks:
type: string
enum:
- unlocked
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126461,11 +125820,11 @@ webhooks:
type: string
enum:
- unpinned
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126538,7 +125897,7 @@ webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *700
+ enterprise: *695
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -127216,9 +126575,9 @@ webhooks:
type: integer
watchers_count:
type: integer
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- forkee
@@ -127364,9 +126723,9 @@ webhooks:
title: gollum event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pages:
description: The pages that were updated.
type: array
@@ -127404,7 +126763,7 @@ webhooks:
- action
- sha
- html_url
- repository: *703
+ repository: *698
sender: *4
required:
- pages
@@ -127480,10 +126839,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: &721
+ organization: *697
+ repositories: &716
description: An array of repository objects that the installation
can access.
type: array
@@ -127509,8 +126868,8 @@ webhooks:
- name
- full_name
- private
- repository: *703
- requester: *720
+ repository: *698
+ requester: *715
sender: *4
required:
- action
@@ -127585,11 +126944,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -127666,11 +127025,11 @@ webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -127747,10 +127106,10 @@ webhooks:
type: string
enum:
- added
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories_added: &722
+ organization: *697
+ repositories_added: &717
description: An array of repository objects, which were added to
the installation.
type: array
@@ -127796,15 +127155,15 @@ webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *703
- repository_selection: &723
+ repository: *698
+ repository_selection: &718
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *720
+ requester: *715
sender: *4
required:
- action
@@ -127883,10 +127242,10 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories_added: *722
+ organization: *697
+ repositories_added: *717
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -127913,9 +127272,9 @@ webhooks:
- name
- full_name
- private
- repository: *703
- repository_selection: *723
- requester: *720
+ repository: *698
+ repository_selection: *718
+ requester: *715
sender: *4
required:
- action
@@ -127994,11 +127353,11 @@ webhooks:
type: string
enum:
- suspend
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -128180,10 +127539,10 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
target_type:
type: string
@@ -128262,11 +127621,11 @@ webhooks:
type: string
enum:
- unsuspend
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -128514,8 +127873,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -129332,8 +128691,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129694,8 +129053,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -129775,7 +129134,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &724
+ comment: &719
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -129942,8 +129301,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -130756,8 +130115,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131120,8 +130479,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -131201,7 +130560,7 @@ webhooks:
type: string
enum:
- edited
- changes: &748
+ changes: &743
description: The changes to the comment.
type: object
properties:
@@ -131213,9 +130572,9 @@ webhooks:
type: string
required:
- from
- comment: *724
- enterprise: *700
- installation: *701
+ comment: *719
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -132031,8 +131390,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132393,8 +131752,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132484,9 +131843,9 @@ webhooks:
type: number
blocking_issue: *70
blocking_issue_repo: *68
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132575,9 +131934,9 @@ webhooks:
type: number
blocking_issue: *70
blocking_issue_repo: *68
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132665,9 +132024,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132756,9 +132115,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132838,10 +132197,10 @@ webhooks:
type: string
enum:
- assigned
- assignee: *720
- enterprise: *700
- installation: *701
- issue: &727
+ assignee: *715
+ enterprise: *695
+ installation: *696
+ issue: &722
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -133653,11 +133012,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133777,8 +133136,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -133858,8 +133217,8 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -134676,11 +134035,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134943,8 +134302,8 @@ webhooks:
required:
- state
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -135023,8 +134382,8 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135832,11 +135191,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135955,8 +135314,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -136035,8 +135394,8 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136867,11 +136226,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136969,7 +136328,7 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: &725
+ milestone: &720
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -137112,8 +136471,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -137212,8 +136571,8 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -138025,11 +137384,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138149,9 +137508,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *719
- organization: *702
- repository: *703
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -138231,8 +137590,8 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -139043,11 +138402,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139167,9 +138526,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *719
- organization: *702
- repository: *703
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -139249,8 +138608,8 @@ webhooks:
type: string
enum:
- locked
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -140086,11 +139445,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140187,8 +139546,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -140267,8 +139626,8 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -141098,11 +140457,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141199,9 +140558,9 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: *725
- organization: *702
- repository: *703
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -142093,11 +141452,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -142674,8 +142033,8 @@ webhooks:
required:
- old_issue
- old_repository
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -143487,11 +142846,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143610,8 +142969,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -143691,9 +143050,9 @@ webhooks:
type: string
enum:
- pinned
- enterprise: *700
- installation: *701
- issue: &726
+ enterprise: *695
+ installation: *696
+ issue: &721
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -144499,11 +143858,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144622,8 +143981,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -144702,8 +144061,8 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -145537,11 +144896,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145639,8 +144998,8 @@ webhooks:
user_view_type:
type: string
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -146529,11 +145888,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147132,11 +146491,11 @@ webhooks:
required:
- new_issue
- new_repository
- enterprise: *700
- installation: *701
- issue: *726
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *721
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147216,12 +146575,12 @@ webhooks:
type: string
enum:
- typed
- enterprise: *700
- installation: *701
- issue: *727
+ enterprise: *695
+ installation: *696
+ issue: *722
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147302,7 +146661,7 @@ webhooks:
type: string
enum:
- unassigned
- assignee: &751
+ assignee: &746
title: User
type:
- object
@@ -147374,11 +146733,11 @@ webhooks:
required:
- login
- id
- enterprise: *700
- installation: *701
- issue: *727
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *722
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147457,12 +146816,12 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *700
- installation: *701
- issue: *727
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *722
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147542,8 +146901,8 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -148377,11 +147736,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148478,8 +147837,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148559,11 +147918,11 @@ webhooks:
type: string
enum:
- unpinned
- enterprise: *700
- installation: *701
- issue: *726
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *721
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148642,12 +148001,12 @@ webhooks:
type: string
enum:
- untyped
- enterprise: *700
- installation: *701
- issue: *727
+ enterprise: *695
+ installation: *696
+ issue: *722
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148727,11 +148086,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148809,11 +148168,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148923,11 +148282,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -149009,9 +148368,9 @@ webhooks:
- cancelled
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: &728
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: &723
title: Marketplace Purchase
type: object
required:
@@ -149099,8 +148458,8 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *702
- previous_marketplace_purchase: &729
+ organization: *697
+ previous_marketplace_purchase: &724
title: Marketplace Purchase
type: object
properties:
@@ -149184,7 +148543,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149264,10 +148623,10 @@ webhooks:
- changed
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149355,7 +148714,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149437,10 +148796,10 @@ webhooks:
- pending_change
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149526,7 +148885,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149607,8 +148966,8 @@ webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149694,9 +149053,9 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *702
- previous_marketplace_purchase: *729
- repository: *703
+ organization: *697
+ previous_marketplace_purchase: *724
+ repository: *698
sender: *4
required:
- action
@@ -149776,12 +149135,12 @@ webhooks:
- purchased
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
- previous_marketplace_purchase: *729
- repository: *703
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
+ previous_marketplace_purchase: *724
+ repository: *698
sender: *4
required:
- action
@@ -149883,11 +149242,11 @@ webhooks:
type: string
required:
- to
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -149989,11 +149348,11 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150072,11 +149431,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150154,11 +149513,11 @@ webhooks:
type: string
enum:
- added
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -150236,7 +149595,7 @@ webhooks:
required:
- login
- id
- team: &730
+ team: &725
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -150466,11 +149825,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -150549,7 +149908,7 @@ webhooks:
required:
- login
- id
- team: *730
+ team: *725
required:
- action
- scope
@@ -150631,8 +149990,8 @@ webhooks:
type: string
enum:
- checks_requested
- installation: *701
- merge_group: &731
+ installation: *696
+ merge_group: &726
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -150651,15 +150010,15 @@ webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *395
+ head_commit: *392
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150745,10 +150104,10 @@ webhooks:
- merged
- invalidated
- dequeued
- installation: *701
- merge_group: *731
- organization: *702
- repository: *703
+ installation: *696
+ merge_group: *726
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150821,7 +150180,7 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
+ enterprise: *695
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -150930,12 +150289,12 @@ webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -151015,11 +150374,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151098,9 +150457,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- milestone: &732
+ enterprise: *695
+ installation: *696
+ milestone: &727
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -151242,8 +150601,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151322,11 +150681,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151436,11 +150795,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151520,11 +150879,11 @@ webhooks:
type: string
enum:
- opened
- enterprise: *700
- installation: *701
- milestone: *732
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *727
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151603,11 +150962,11 @@ webhooks:
type: string
enum:
- blocked
- blocked_user: *720
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ blocked_user: *715
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151686,11 +151045,11 @@ webhooks:
type: string
enum:
- unblocked
- blocked_user: *720
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ blocked_user: *715
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151769,9 +151128,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- membership: &733
+ enterprise: *695
+ installation: *696
+ membership: &728
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -151881,8 +151240,8 @@ webhooks:
- role
- organization_url
- user
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151960,11 +151319,11 @@ webhooks:
type: string
enum:
- member_added
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152043,8 +151402,8 @@ webhooks:
type: string
enum:
- member_invited
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -152166,10 +151525,10 @@ webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
- user: *720
+ user: *715
required:
- action
- invitation
@@ -152247,11 +151606,11 @@ webhooks:
type: string
enum:
- member_removed
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152338,11 +151697,11 @@ webhooks:
properties:
from:
type: string
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152418,9 +151777,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
package:
description: Information about the package.
type: object
@@ -152943,7 +152302,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: &734
+ items: &729
title: Ruby Gems metadata
type: object
properties:
@@ -153040,7 +152399,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -153116,9 +152475,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
package:
description: Information about the package.
type: object
@@ -153480,7 +152839,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *734
+ items: *729
source_url:
type: string
format: uri
@@ -153551,7 +152910,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -153732,12 +153091,12 @@ webhooks:
- duration
- created_at
- updated_at
- enterprise: *700
+ enterprise: *695
id:
type: integer
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- id
@@ -153814,7 +153173,7 @@ webhooks:
type: string
enum:
- approved
- personal_access_token_request: &735
+ personal_access_token_request: &730
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -153964,10 +153323,10 @@ webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *700
- organization: *702
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154044,11 +153403,11 @@ webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *735
- enterprise: *700
- organization: *702
+ personal_access_token_request: *730
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154124,11 +153483,11 @@ webhooks:
type: string
enum:
- created
- personal_access_token_request: *735
- enterprise: *700
- organization: *702
+ personal_access_token_request: *730
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154203,11 +153562,11 @@ webhooks:
type: string
enum:
- denied
- personal_access_token_request: *735
- organization: *702
- enterprise: *700
+ personal_access_token_request: *730
+ organization: *697
+ enterprise: *695
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154312,7 +153671,7 @@ webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *736
+ last_response: *731
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -154344,8 +153703,8 @@ webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
zen:
description: Random string of GitHub zen.
@@ -154590,10 +153949,10 @@ webhooks:
- from
required:
- note
- enterprise: *700
- installation: *701
- organization: *702
- project_card: &737
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: &732
title: Project Card
type: object
properties:
@@ -154716,7 +154075,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -154797,11 +154156,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project_card: *737
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: *732
+ repository: *698
sender: *4
required:
- action
@@ -154881,9 +154240,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
project_card:
title: Project Card
type: object
@@ -155013,7 +154372,7 @@ webhooks:
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -155107,11 +154466,11 @@ webhooks:
- from
required:
- note
- enterprise: *700
- installation: *701
- organization: *702
- project_card: *737
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: *732
+ repository: *698
sender: *4
required:
- action
@@ -155205,9 +154564,9 @@ webhooks:
- from
required:
- column_id
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
project_card:
allOf:
- title: Project Card
@@ -155404,7 +154763,7 @@ webhooks:
type: string
required:
- after_id
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155484,10 +154843,10 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- organization: *702
- project: &739
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: &734
title: Project
type: object
properties:
@@ -155614,7 +154973,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155694,10 +155053,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project_column: &738
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: &733
title: Project Column
type: object
properties:
@@ -155737,7 +155096,7 @@ webhooks:
- name
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155816,14 +155175,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -155912,11 +155271,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
+ repository: *698
sender: *4
required:
- action
@@ -155996,11 +155355,11 @@ webhooks:
type: string
enum:
- moved
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
+ repository: *698
sender: *4
required:
- action
@@ -156080,11 +155439,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156164,14 +155523,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -156272,11 +155631,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156355,11 +155714,11 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156440,8 +155799,8 @@ webhooks:
type: string
enum:
- closed
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156523,8 +155882,8 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156606,8 +155965,8 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156729,8 +156088,8 @@ webhooks:
type: string
to:
type: string
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156814,7 +156173,7 @@ webhooks:
type: string
enum:
- archived
- changes: &743
+ changes: &738
type: object
properties:
archived_at:
@@ -156830,9 +156189,9 @@ webhooks:
- string
- 'null'
format: date-time
- installation: *701
- organization: *702
- projects_v2_item: &740
+ installation: *696
+ organization: *697
+ projects_v2_item: &735
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -156972,9 +156331,9 @@ webhooks:
- 'null'
to:
type: string
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157056,9 +156415,9 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157139,9 +156498,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157246,7 +156605,7 @@ webhooks:
oneOf:
- type: string
- type: integer
- - &741
+ - &736
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -157270,7 +156629,7 @@ webhooks:
required:
- id
- name
- - &742
+ - &737
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -157310,8 +156669,8 @@ webhooks:
oneOf:
- type: string
- type: integer
- - *741
- - *742
+ - *736
+ - *737
type:
- 'null'
- string
@@ -157334,9 +156693,9 @@ webhooks:
- 'null'
required:
- body
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157433,9 +156792,9 @@ webhooks:
type:
- string
- 'null'
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157518,10 +156877,10 @@ webhooks:
type: string
enum:
- restored
- changes: *743
- installation: *701
- organization: *702
- projects_v2_item: *740
+ changes: *738
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157603,8 +156962,8 @@ webhooks:
type: string
enum:
- reopened
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -157686,9 +157045,9 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157769,9 +157128,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157917,9 +157276,9 @@ webhooks:
- string
- 'null'
format: date
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157990,10 +157349,10 @@ webhooks:
title: public event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- repository
@@ -158070,13 +157429,13 @@ webhooks:
type: string
enum:
- assigned
- assignee: *720
- enterprise: *700
- installation: *701
- number: &745
+ assignee: *715
+ enterprise: *695
+ installation: *696
+ number: &740
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -160425,7 +159784,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -160507,11 +159866,11 @@ webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -162853,7 +162212,7 @@ webhooks:
- draft
reason:
type: string
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -162935,11 +162294,11 @@ webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -165281,7 +164640,7 @@ webhooks:
- draft
reason:
type: string
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -165363,13 +164722,13 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: &746
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: &741
allOf:
- - *555
+ - *552
- type: object
properties:
allow_auto_merge:
@@ -165431,7 +164790,7 @@ webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -165512,12 +164871,12 @@ webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -165597,11 +164956,11 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *700
+ enterprise: *695
milestone: *252
- number: *745
- organization: *702
- pull_request: &747
+ number: *740
+ organization: *697
+ pull_request: &742
title: Pull Request
type: object
properties:
@@ -167928,7 +167287,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -168007,11 +167366,11 @@ webhooks:
type: string
enum:
- dequeued
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -170357,7 +169716,7 @@ webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -170481,12 +169840,12 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -170566,11 +169925,11 @@ webhooks:
type: string
enum:
- enqueued
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -172901,7 +172260,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -172981,11 +172340,11 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *700
- installation: *701
- label: *719
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ label: *714
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -175333,7 +174692,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -175414,10 +174773,10 @@ webhooks:
type: string
enum:
- locked
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -177763,7 +177122,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -177843,12 +177202,12 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *700
+ enterprise: *695
milestone: *252
- number: *745
- organization: *702
- pull_request: *747
- repository: *703
+ number: *740
+ organization: *697
+ pull_request: *742
+ repository: *698
sender: *4
required:
- action
@@ -177927,12 +177286,12 @@ webhooks:
type: string
enum:
- opened
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178013,12 +177372,12 @@ webhooks:
type: string
enum:
- ready_for_review
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178098,12 +177457,12 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178478,9 +177837,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -180710,7 +180069,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -180790,7 +180149,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &749
+ comment: &744
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -181083,9 +180442,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -183303,7 +182662,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -183383,11 +182742,11 @@ webhooks:
type: string
enum:
- edited
- changes: *748
- comment: *749
- enterprise: *700
- installation: *701
- organization: *702
+ changes: *743
+ comment: *744
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -185608,7 +184967,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -185689,9 +185048,9 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -187924,7 +187283,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
review:
description: The review that was affected.
type: object
@@ -188175,9 +187534,9 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -190291,8 +189650,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
- review: &750
+ repository: *698
+ review: &745
description: The review that was affected.
type: object
properties:
@@ -190530,12 +189889,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -192882,7 +192241,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_reviewer:
title: User
type:
@@ -192968,12 +192327,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -195327,7 +194686,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195522,12 +194881,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -197876,7 +197235,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_reviewer:
title: User
type:
@@ -197963,12 +197322,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -200308,7 +199667,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -200492,9 +199851,9 @@ webhooks:
type: string
enum:
- submitted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -202730,8 +202089,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
- review: *750
+ repository: *698
+ review: *745
sender: *4
required:
- action
@@ -202811,9 +202170,9 @@ webhooks:
type: string
enum:
- resolved
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -204944,7 +204303,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
thread:
type: object
@@ -205341,9 +204700,9 @@ webhooks:
type: string
enum:
- unresolved
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -207457,7 +206816,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
thread:
type: object
@@ -207856,10 +207215,10 @@ webhooks:
type: string
before:
type: string
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -210194,7 +209553,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -210276,11 +209635,11 @@ webhooks:
type: string
enum:
- unassigned
- assignee: *751
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ assignee: *746
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -212630,7 +211989,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -212709,11 +212068,11 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *700
- installation: *701
- label: *719
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ label: *714
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -215052,7 +214411,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -215133,10 +214492,10 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -217465,7 +216824,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -217668,7 +217027,7 @@ webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *700
+ enterprise: *695
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -217763,8 +217122,8 @@ webhooks:
- url
- author
- committer
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -218352,9 +217711,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
registry_package:
type: object
properties:
@@ -218831,7 +218190,7 @@ webhooks:
type: string
rubygems_metadata:
type: array
- items: *734
+ items: *729
summary:
type: string
tag_name:
@@ -218887,7 +218246,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -218965,9 +218324,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
registry_package:
type: object
properties:
@@ -219279,7 +218638,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *734
+ items: *729
summary:
type: string
tag_name:
@@ -219329,7 +218688,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -219406,10 +218765,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- release: &752
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: &747
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -219740,7 +219099,7 @@ webhooks:
- updated_at
- zipball_url
- body
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -219817,11 +219176,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -219938,11 +219297,11 @@ webhooks:
type: boolean
required:
- to
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -220020,9 +219379,9 @@ webhooks:
type: string
enum:
- prereleased
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -220358,7 +219717,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -220434,10 +219793,10 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- release: &753
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: &748
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -220770,7 +220129,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -220846,11 +220205,11 @@ webhooks:
type: string
enum:
- released
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -220926,11 +220285,11 @@ webhooks:
type: string
enum:
- unpublished
- enterprise: *700
- installation: *701
- organization: *702
- release: *753
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *748
+ repository: *698
sender: *4
required:
- action
@@ -221006,11 +220365,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- repository_advisory: *619
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ repository_advisory: *616
sender: *4
required:
- action
@@ -221086,11 +220445,11 @@ webhooks:
type: string
enum:
- reported
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- repository_advisory: *619
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ repository_advisory: *616
sender: *4
required:
- action
@@ -221166,10 +220525,10 @@ webhooks:
type: string
enum:
- archived
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221246,10 +220605,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221327,10 +220686,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221415,10 +220774,10 @@ webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221533,10 +220892,10 @@ webhooks:
- 'null'
items:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221608,10 +220967,10 @@ webhooks:
title: repository_import event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
status:
type: string
@@ -221692,10 +221051,10 @@ webhooks:
type: string
enum:
- privatized
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221772,10 +221131,10 @@ webhooks:
type: string
enum:
- publicized
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221869,10 +221228,10 @@ webhooks:
- name
required:
- repository
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221952,10 +221311,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
sender: *4
required:
@@ -222034,10 +221393,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
sender: *4
required:
@@ -222116,10 +221475,10 @@ webhooks:
type: string
enum:
- edited
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
changes:
type: object
@@ -222181,16 +221540,16 @@ webhooks:
properties:
added:
type: array
- items: *575
+ items: *572
deleted:
type: array
- items: *575
+ items: *572
updated:
type: array
items:
type: object
properties:
- rule: *575
+ rule: *572
changes:
type: object
properties:
@@ -222427,10 +221786,10 @@ webhooks:
- from
required:
- owner
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222508,10 +221867,10 @@ webhooks:
type: string
enum:
- unarchived
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222589,7 +221948,7 @@ webhooks:
type: string
enum:
- create
- alert: &754
+ alert: &749
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -222713,10 +222072,10 @@ webhooks:
type: string
enum:
- open
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222926,10 +222285,10 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223007,11 +222366,11 @@ webhooks:
type: string
enum:
- reopen
- alert: *754
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *749
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223213,10 +222572,10 @@ webhooks:
enum:
- fixed
- open
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223294,7 +222653,7 @@ webhooks:
type: string
enum:
- assigned
- alert: &755
+ alert: &750
type: object
properties:
number: *162
@@ -223409,10 +222768,10 @@ webhooks:
- type: 'null'
- *4
assignee: *4
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223490,11 +222849,11 @@ webhooks:
type: string
enum:
- created
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223575,11 +222934,11 @@ webhooks:
type: string
enum:
- created
- alert: *755
- installation: *701
- location: *756
- organization: *702
- repository: *703
+ alert: *750
+ installation: *696
+ location: *751
+ organization: *697
+ repository: *698
sender: *4
required:
- location
@@ -223817,11 +223176,11 @@ webhooks:
type: string
enum:
- publicly_leaked
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223899,11 +223258,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223981,11 +223340,11 @@ webhooks:
type: string
enum:
- resolved
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224063,12 +223422,12 @@ webhooks:
type: string
enum:
- unassigned
- alert: *755
+ alert: *750
assignee: *4
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224146,11 +223505,11 @@ webhooks:
type: string
enum:
- validated
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224280,10 +223639,10 @@ webhooks:
- organization
- enterprise
-
- repository: *703
- enterprise: *700
- installation: *701
- organization: *702
+ repository: *698
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -224361,11 +223720,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- security_advisory: &757
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ security_advisory: &752
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -224551,11 +223910,11 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- security_advisory: *757
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ security_advisory: *752
sender: *4
required:
- action
@@ -224628,10 +223987,10 @@ webhooks:
type: string
enum:
- withdrawn
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -224818,10 +224177,10 @@ webhooks:
type: object
properties:
security_and_analysis: *265
- enterprise: *700
- installation: *701
- organization: *702
- repository: *317
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *314
sender: *4
required:
- changes
@@ -224899,12 +224258,12 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: &758
+ sponsorship: &753
type: object
properties:
created_at:
@@ -225209,12 +224568,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- sponsorship
@@ -225302,12 +224661,12 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225384,17 +224743,17 @@ webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &759
+ effective_date: &754
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: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- sponsorship
@@ -225468,7 +224827,7 @@ webhooks:
type: string
enum:
- pending_tier_change
- changes: &760
+ changes: &755
type: object
properties:
tier:
@@ -225512,13 +224871,13 @@ webhooks:
- from
required:
- tier
- effective_date: *759
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ effective_date: *754
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225595,13 +224954,13 @@ webhooks:
type: string
enum:
- tier_changed
- changes: *760
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ changes: *755
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225675,10 +225034,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -225762,10 +225121,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -226199,15 +225558,15 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
+ enterprise: *695
id:
description: The unique identifier of the status.
type: integer
- installation: *701
+ installation: *696
name:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
sha:
description: The Commit SHA.
@@ -226323,9 +225682,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226415,9 +225774,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226507,9 +225866,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226599,9 +225958,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226678,12 +226037,12 @@ webhooks:
title: team_add event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- team: &761
+ team: &756
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -226913,9 +226272,9 @@ webhooks:
type: string
enum:
- added_to_repository
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -227385,7 +226744,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -227461,9 +226820,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -227933,7 +227292,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -228010,9 +227369,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -228482,7 +227841,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -228626,9 +227985,9 @@ webhooks:
- from
required:
- permissions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -229098,7 +228457,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- changes
@@ -229176,9 +228535,9 @@ webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -229648,7 +229007,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -229724,10 +229083,10 @@ webhooks:
type: string
enum:
- started
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -229800,17 +229159,17 @@ webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *700
+ enterprise: *695
inputs:
type:
- object
- 'null'
additionalProperties: true
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
ref:
type: string
- repository: *703
+ repository: *698
sender: *4
workflow:
type: string
@@ -229892,10 +229251,10 @@ webhooks:
type: string
enum:
- completed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
allOf:
@@ -230151,7 +229510,7 @@ webhooks:
type: string
required:
- conclusion
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230230,10 +229589,10 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
allOf:
@@ -230515,7 +229874,7 @@ webhooks:
required:
- status
- steps
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230594,10 +229953,10 @@ webhooks:
type: string
enum:
- queued
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
type: object
@@ -230743,7 +230102,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230822,10 +230181,10 @@ webhooks:
type: string
enum:
- waiting
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
type: object
@@ -230972,7 +230331,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -231052,12 +230411,12 @@ webhooks:
type: string
enum:
- completed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
@@ -232076,12 +231435,12 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
@@ -233085,12 +232444,12 @@ webhooks:
type: string
enum:
- requested
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
index 5226d58a1..e72800b67 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
@@ -229832,19 +229832,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -229976,8 +229963,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230019,8 +230004,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",
@@ -230340,19 +230323,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -230484,8 +230454,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230525,8 +230493,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",
@@ -230812,19 +230778,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -230956,8 +230909,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -230997,8 +230948,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",
@@ -231308,19 +231257,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -231452,8 +231388,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -231493,8 +231427,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",
@@ -231585,17 +231517,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": [
{
@@ -231617,26 +231549,376 @@
}
},
{
- "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/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",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "failed_reason": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "inviter": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
+ ]
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "team_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ ]
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "examples": [
+ "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ ]
+ },
+ "invitation_source": {
+ "type": "string",
+ "examples": [
+ "\"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": "integer"
+ "type": "string"
}
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
+ "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": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -231666,322 +231948,170 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
+ "name": {
+ "type": [
+ "string",
+ "null"
]
},
- "body": {
- "description": "The main text of the comment.",
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "octocat"
]
},
- "body_html": {
- "type": "string",
+ "id": {
+ "type": "integer",
+ "format": "int64",
"examples": [
- "Do you like apples?
"
+ 1
]
},
- "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.",
+ "node_id": {
"type": "string",
"examples": [
- "0307116bbf7ced493b8d8a346c650b71"
+ "MDQ6VXNlcjE="
]
},
- "created_at": {
+ "avatar_url": {
"type": "string",
- "format": "date-time",
+ "format": "uri",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://github.com/images/error/octocat_happy.gif"
]
},
- "last_edited_at": {
+ "gravatar_id": {
"type": [
"string",
"null"
],
- "format": "date-time"
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "https://api.github.com/users/octocat"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/octocat"
]
},
- "node_id": {
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "https://api.github.com/users/octocat/followers"
]
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
+ "following_url": {
+ "type": "string",
"examples": [
- 42
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
]
},
- "url": {
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "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",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
},
"required": [
- "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"
]
}
@@ -231990,49 +232120,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
}
]
}
@@ -232053,19 +232158,126 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "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",
+ "type": "string",
+ "examples": [
+ "member"
+ ]
+ },
+ "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"
}
},
- "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.",
+ "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/create-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#create-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -232087,35 +232299,38 @@
}
},
{
- "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"
}
}
],
"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"
}
}
}
@@ -232123,403 +232338,83 @@
}
},
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
+ "url": {
"type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "format": "uri"
},
- "last_edited_at": {
- "type": [
- "string",
- "null"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
+ "default": "member",
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "member"
]
},
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- }
- },
- "/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.",
+ },
+ "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/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\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/get-discussion-comment-in-org",
+ "operationId": "teams/remove-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#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -232541,978 +232436,78 @@
}
},
{
- "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": {
+ "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/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": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
- }
- }
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "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"
- }
- }
- ],
- "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": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
+ "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
}
}
],
@@ -233524,45 +232519,36 @@
"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",
- "null"
+ "format": "int64",
+ "examples": [
+ 1296269
]
},
- "email": {
- "type": [
- "string",
- "null"
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
]
},
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": [
- "string",
- "null"
+ "name": {
+ "type": "string",
+ "examples": [
+ "Hello-World"
]
},
- "failed_reason": {
- "type": [
- "string",
- "null"
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
]
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -233730,974 +232716,39 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "https://github.com/octocat/Hello-World"
]
},
- "invitation_teams_url": {
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "https://api.github.com/repos/octocat/Hello-World"
]
},
- "invitation_source": {
+ "archive_url": {
"type": "string",
"examples": [
- "\"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": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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/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\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/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/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/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": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1296269
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Hello-World"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "This your first repo!"
- ]
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/repos/octocat/Hello-World"
- ]
- },
- "archive_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
]
},
"assignees_url": {
@@ -623941,2801 +621992,715 @@
"closed"
]
},
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "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",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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/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": {
- "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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "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": {
@@ -626744,20 +622709,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": [
{
@@ -626768,20 +622733,112 @@
"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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -626790,22 +622847,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": [
{
@@ -626817,15 +622874,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.",
@@ -626867,8 +622915,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": {
@@ -627047,16 +623095,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627070,7 +623118,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627080,45 +623128,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -627178,10 +623247,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -627211,19 +623283,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,
@@ -627256,20 +623331,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": [
{
@@ -627280,15 +623355,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -627298,19 +623364,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."
}
}
}
@@ -627323,8 +623400,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": {
@@ -627503,16 +623580,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627526,7 +623603,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627536,45 +623613,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -627634,10 +623732,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -627665,19 +623766,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,
@@ -627702,22 +623806,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": [
{
@@ -627737,15 +623841,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -627754,8 +623849,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": {
@@ -627934,16 +624029,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -627957,7 +624052,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -627967,45 +624062,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -628065,10 +624181,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -628096,19 +624215,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,
@@ -628132,20 +624254,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": [
{
@@ -628165,37 +624287,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"
}
}
}
@@ -628208,8 +624322,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": {
@@ -628388,16 +624502,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -628411,7 +624525,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -628421,45 +624535,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -628519,10 +624654,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -628550,19 +624688,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,
@@ -628586,20 +624727,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": [
{
@@ -628619,15 +624760,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -628641,7 +624773,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
index 121df3240..d25fea90c 100644
--- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
+++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
@@ -1071,7 +1071,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &621
+ - &618
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -9169,7 +9169,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
- - &460
+ - &457
name: has
in: query
description: |-
@@ -9289,7 +9289,7 @@ paths:
- direct
- transitive
-
- security_advisory: &461
+ security_advisory: &458
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9557,7 +9557,7 @@ paths:
and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- auto_dismissed_at: &462
+ auto_dismissed_at: &459
type:
- string
- 'null'
@@ -9565,7 +9565,7 @@ paths:
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissal_request: &463
+ dismissal_request: &460
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10956,7 +10956,7 @@ paths:
properties:
action:
type: string
- discussion: &716
+ discussion: &711
title: Discussion
description: A Discussion in a repository.
type: object
@@ -11742,7 +11742,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &633
+ sub_issues_summary: &630
title: Sub-issues Summary
type: object
properties:
@@ -11763,7 +11763,7 @@ paths:
- string
- 'null'
format: uri
- issue_dependencies_summary: &634
+ issue_dependencies_summary: &631
title: Issue Dependencies Summary
type: object
properties:
@@ -11782,7 +11782,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &635
+ items: &632
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11895,7 +11895,7 @@ paths:
action:
type: string
issue: *70
- comment: &510
+ comment: &507
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12618,7 +12618,7 @@ paths:
type: string
release:
allOf:
- - &566
+ - &563
title: Release
description: A release.
type: object
@@ -12700,7 +12700,7 @@ paths:
author: *4
assets:
type: array
- items: &567
+ items: &564
title: Release Asset
description: Data related to a release.
type: object
@@ -13303,7 +13303,7 @@ paths:
url:
type: string
format: uri
- user: &645
+ user: &640
title: Public User
description: Public User
type: object
@@ -16660,14 +16660,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &314
+ - &311
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &315
+ - &312
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16729,7 +16729,7 @@ paths:
'404': *6
'403': *27
'304': *35
- '301': &318
+ '301': &315
description: Moved permanently
content:
application/json:
@@ -16751,7 +16751,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &540
+ - &537
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16759,7 +16759,7 @@ paths:
schema:
type: boolean
default: false
- - &541
+ - &538
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16769,7 +16769,7 @@ paths:
type: boolean
default: false
- *76
- - &542
+ - &539
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:
@@ -17305,7 +17305,7 @@ paths:
- url
- subscription_url
examples:
- default: &543
+ default: &540
value:
- id: '1'
repository:
@@ -18332,7 +18332,7 @@ paths:
- property_name
- value
examples:
- default: &549
+ default: &546
value:
- property_name: environment
value: production
@@ -18382,7 +18382,7 @@ paths:
required:
- properties
examples:
- default: &550
+ default: &547
value:
properties:
- property_name: environment
@@ -18956,7 +18956,7 @@ paths:
required: false
schema:
type: string
- - &693
+ - &688
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -19102,7 +19102,7 @@ paths:
parameters:
- *65
- *107
- - &694
+ - &689
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
@@ -19214,7 +19214,7 @@ paths:
- *107
- *109
- *108
- - &695
+ - &690
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -19222,7 +19222,7 @@ paths:
schema:
type: string
- *110
- - &696
+ - &691
name: sku
description: The SKU to query for usage.
in: query
@@ -20201,7 +20201,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &325
+ items: &322
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -21439,7 +21439,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &331
+ selected_actions_url: &328
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`
@@ -21522,7 +21522,7 @@ paths:
description: Response
content:
application/json:
- schema: &335
+ schema: &332
type: object
properties:
days:
@@ -21564,7 +21564,7 @@ paths:
required: true
content:
application/json:
- schema: &336
+ schema: &333
type: object
properties:
days:
@@ -21621,7 +21621,7 @@ paths:
required:
- approval_policy
examples:
- default: &337
+ default: &334
value:
approval_policy: first_time_contributors
'404': *6
@@ -21680,7 +21680,7 @@ paths:
description: Response
content:
application/json:
- schema: &338
+ schema: &335
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21734,7 +21734,7 @@ paths:
required: true
content:
application/json:
- schema: &339
+ schema: &336
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -22369,7 +22369,7 @@ paths:
description: Response
content:
application/json:
- schema: &340
+ schema: &337
type: object
properties:
default_workflow_permissions: &137
@@ -22420,7 +22420,7 @@ paths:
required: false
content:
application/json:
- schema: &341
+ schema: &338
type: object
properties:
default_workflow_permissions: *137
@@ -22913,7 +22913,7 @@ paths:
type: array
items: *144
examples:
- default: &648
+ default: &643
value:
total_count: 1
repositories:
@@ -23560,7 +23560,7 @@ paths:
application/json:
schema:
type: array
- items: &342
+ items: &339
title: Runner Application
description: Runner Application
type: object
@@ -23585,7 +23585,7 @@ paths:
- download_url
- filename
examples:
- default: &343
+ default: &340
value:
- os: osx
architecture: x64
@@ -23671,7 +23671,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &344
+ '201': &341
description: Response
content:
application/json:
@@ -23786,7 +23786,7 @@ paths:
- token
- expires_at
examples:
- default: &345
+ default: &342
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23825,7 +23825,7 @@ paths:
application/json:
schema: *148
examples:
- default: &346
+ default: &343
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23859,7 +23859,7 @@ paths:
application/json:
schema: *146
examples:
- default: &347
+ default: &344
value:
id: 23
name: MBP
@@ -24085,7 +24085,7 @@ paths:
- *65
- *145
responses:
- '200': &348
+ '200': &345
description: Response
content:
application/json:
@@ -24142,7 +24142,7 @@ paths:
parameters:
- *65
- *145
- - &349
+ - &346
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -24274,7 +24274,7 @@ paths:
description: Response
content:
application/json:
- schema: &361
+ schema: &358
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -24309,7 +24309,7 @@ paths:
- key_id
- key
examples:
- default: &362
+ default: &359
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -24722,7 +24722,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *65
- - &330
+ - &327
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)."
@@ -25883,12 +25883,12 @@ paths:
required:
- subject_digests
examples:
- default: &675
+ default: &670
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &676
+ withPredicateType: &671
value:
subject_digests:
- sha256:abc123
@@ -25947,7 +25947,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &677
+ default: &672
value:
attestations_subject_digests:
- sha256:abc:
@@ -26296,7 +26296,7 @@ paths:
initiator:
type: string
examples:
- default: &375
+ default: &372
value:
attestations:
- bundle:
@@ -27252,7 +27252,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *65
- - &399
+ - &396
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`,
@@ -27262,7 +27262,7 @@ paths:
schema: &169
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &400
+ - &397
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
@@ -27286,7 +27286,7 @@ paths:
be returned.
in: query
required: false
- schema: &402
+ schema: &399
type: string
description: State of a code scanning alert.
enum:
@@ -27309,7 +27309,7 @@ paths:
be returned.
in: query
required: false
- schema: &403
+ schema: &400
type: string
description: Severity of a code scanning alert.
enum:
@@ -27343,7 +27343,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: &404
+ instances_url: &401
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -27365,7 +27365,7 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: &405
+ dismissed_reason: &402
type:
- string
- 'null'
@@ -27376,14 +27376,14 @@ paths:
- won't fix
- used in tests
-
- dismissed_comment: &406
+ dismissed_comment: &403
type:
- string
- 'null'
description: The dismissal comment associated with the dismissal
of the alert.
maxLength: 280
- rule: &407
+ rule: &404
type: object
properties:
id:
@@ -27444,7 +27444,7 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: &408
+ tool: &405
type: object
properties:
name: *169
@@ -27455,26 +27455,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *170
- most_recent_instance: &409
+ most_recent_instance: &406
type: object
properties:
- ref: &401
+ ref: &398
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &419
+ analysis_key: &416
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: &420
+ environment: &417
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: &421
+ category: &418
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -27488,7 +27488,7 @@ paths:
properties:
text:
type: string
- location: &422
+ location: &419
type: object
description: Describe a region within a file for the alert.
properties:
@@ -27509,7 +27509,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: &423
+ items: &420
type:
- string
- 'null'
@@ -28802,7 +28802,7 @@ paths:
machine:
anyOf:
- type: 'null'
- - &435
+ - &432
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
@@ -29754,7 +29754,7 @@ paths:
- updated_at
- visibility
examples:
- default: &436
+ default: &433
value:
total_count: 2
secrets:
@@ -29792,7 +29792,7 @@ paths:
description: Response
content:
application/json:
- schema: &437
+ schema: &434
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -29827,7 +29827,7 @@ paths:
- key_id
- key
examples:
- default: &438
+ default: &435
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -29859,7 +29859,7 @@ paths:
application/json:
schema: *179
examples:
- default: &440
+ default: &437
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -31482,7 +31482,7 @@ paths:
description: Response
content:
application/json:
- schema: &466
+ schema: &463
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -31501,7 +31501,7 @@ paths:
- key_id
- key
examples:
- default: &467
+ default: &464
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -33329,7 +33329,7 @@ paths:
application/json:
schema: *20
examples:
- default: &505
+ default: &502
value:
id: 1
account:
@@ -33557,7 +33557,7 @@ paths:
required: true
content:
application/json:
- schema: &506
+ schema: &503
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -34417,7 +34417,7 @@ paths:
application/json:
schema: *221
examples:
- default: &434
+ default: &431
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -35679,7 +35679,7 @@ paths:
parameters:
- *65
- *228
- - &660
+ - &655
name: repo_name
description: repo_name parameter
in: path
@@ -36738,7 +36738,7 @@ paths:
- nuget
- container
- *65
- - &661
+ - &656
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -36779,7 +36779,7 @@ paths:
default: *234
'403': *27
'401': *23
- '400': &663
+ '400': &658
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -38605,7 +38605,7 @@ paths:
latest_status_update:
anyOf:
- type: 'null'
- - &744
+ - &739
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -38879,7 +38879,7 @@ paths:
content:
oneOf:
- *70
- - &449
+ - &446
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -39124,7 +39124,7 @@ paths:
- review_comment
- self
author_association: *71
- auto_merge: &552
+ auto_merge: &549
title: Auto merge
description: The status of auto merging a pull request.
type:
@@ -39506,7 +39506,7 @@ paths:
- updated_at
- project_url
examples:
- default: &680
+ default: &675
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -39683,7 +39683,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &681
+ items: &676
type: object
properties:
name:
@@ -39719,7 +39719,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &682
+ iteration_configuration: &677
type: object
description: The configuration for iteration fields.
properties:
@@ -39768,7 +39768,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &683
+ single_select_field: &678
summary: Create a single select field
value:
name: Priority
@@ -39795,7 +39795,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &684
+ iteration_field: &679
summary: Create an iteration field
value:
name: Sprint
@@ -39821,7 +39821,7 @@ paths:
application/json:
schema: *254
examples:
- text_field: &685
+ text_field: &680
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -39830,7 +39830,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: &686
+ number_field: &681
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -39839,7 +39839,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: &687
+ date_field: &682
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -39848,7 +39848,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: &688
+ single_select_field: &683
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -39882,7 +39882,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &689
+ iteration_field: &684
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -39928,7 +39928,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *251
- - &690
+ - &685
name: field_id
description: The unique identifier of the field.
in: path
@@ -39943,7 +39943,7 @@ paths:
application/json:
schema: *254
examples:
- default: &691
+ default: &686
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -41076,7 +41076,7 @@ paths:
parameters:
- *251
- *65
- - &692
+ - &687
name: view_number
description: The number that identifies the project view.
in: path
@@ -42011,7 +42011,7 @@ paths:
description: Response
content:
application/json:
- schema: &317
+ schema: &314
title: Full Repository
description: Full Repository
type: object
@@ -42476,7 +42476,7 @@ paths:
description: Whether anonymous git access is allowed.
default: true
type: boolean
- code_of_conduct: &454
+ code_of_conduct: &451
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
@@ -42590,7 +42590,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &319
+ default: &316
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -43111,7 +43111,7 @@ paths:
- *65
- *17
- *19
- - &574
+ - &571
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -43397,7 +43397,7 @@ paths:
- object
rules:
type: array
- items: &575
+ items: &572
title: Repository Rule
type: object
description: A repository rule.
@@ -43459,7 +43459,7 @@ paths:
type: string
enum:
- required_linear_history
- - &573
+ - &570
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -44355,7 +44355,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *65
- - &576
+ - &573
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
@@ -44370,7 +44370,7 @@ paths:
in: query
schema:
type: string
- - &577
+ - &574
name: time_period
description: |-
The time period to filter by.
@@ -44386,14 +44386,14 @@ paths:
- week
- month
default: day
- - &578
+ - &575
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
- - &579
+ - &576
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -44413,7 +44413,7 @@ paths:
description: Response
content:
application/json:
- schema: &580
+ schema: &577
title: Rule Suites
description: Response
type: array
@@ -44469,7 +44469,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &581
+ default: &578
value:
- id: 21
actor_id: 12
@@ -44513,7 +44513,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *65
- - &582
+ - &579
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -44529,7 +44529,7 @@ paths:
description: Response
content:
application/json:
- schema: &583
+ schema: &580
title: Rule Suite
description: Response
type: object
@@ -44636,7 +44636,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &584
+ default: &581
value:
id: 21
actor_id: 12
@@ -44882,7 +44882,7 @@ paths:
type: string
format: date-time
examples:
- default: &586
+ default: &583
value:
- version_id: 3
actor:
@@ -44935,7 +44935,7 @@ paths:
description: Response
content:
application/json:
- schema: &587
+ schema: &584
allOf:
- *295
- type: object
@@ -45007,7 +45007,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *65
- - &588
+ - &585
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -45018,7 +45018,7 @@ paths:
enum:
- open
- resolved
- - &589
+ - &586
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -45028,7 +45028,7 @@ paths:
required: false
schema:
type: string
- - &590
+ - &587
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -45037,7 +45037,7 @@ paths:
required: false
schema:
type: string
- - &591
+ - &588
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -45056,7 +45056,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &592
+ - &589
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.
@@ -45071,7 +45071,7 @@ paths:
- *50
- *19
- *17
- - &593
+ - &590
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
@@ -45081,7 +45081,7 @@ paths:
required: false
schema:
type: string
- - &594
+ - &591
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
@@ -45091,7 +45091,7 @@ paths:
required: false
schema:
type: string
- - &595
+ - &592
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -45100,7 +45100,7 @@ paths:
required: false
schema:
type: string
- - &596
+ - &593
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -45109,7 +45109,7 @@ paths:
schema:
type: boolean
default: false
- - &597
+ - &594
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -45118,7 +45118,7 @@ paths:
schema:
type: boolean
default: false
- - &598
+ - &595
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -45150,14 +45150,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &599
+ state: &596
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: &600
+ resolution: &597
type:
- string
- 'null'
@@ -45264,14 +45264,14 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - &601
+ - &598
description: 'Details on the location where the token was
initially detected. This can be a commit, wiki commit, issue,
discussion, pull request.
'
oneOf:
- - &603
+ - &600
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -45328,7 +45328,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &604
+ - &601
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.
@@ -45389,7 +45389,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &605
+ - &602
description: Represents an 'issue_title' secret scanning
location type. This location type shows that a secret
was detected in the title of an issue.
@@ -45404,7 +45404,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &606
+ - &603
description: Represents an 'issue_body' secret scanning
location type. This location type shows that a secret
was detected in the body of an issue.
@@ -45419,7 +45419,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &607
+ - &604
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on an issue.
@@ -45434,7 +45434,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &608
+ - &605
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret
was detected in the title of a discussion.
@@ -45449,7 +45449,7 @@ paths:
- https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &609
+ - &606
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret
was detected in the body of a discussion.
@@ -45464,7 +45464,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &610
+ - &607
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on a discussion.
@@ -45479,7 +45479,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &611
+ - &608
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.
@@ -45494,7 +45494,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &612
+ - &609
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.
@@ -45509,7 +45509,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &613
+ - &610
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.
@@ -45524,7 +45524,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &614
+ - &611
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.
@@ -45539,7 +45539,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &615
+ - &612
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
@@ -46039,7 +46039,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &616
description: A repository security advisory.
type: object
properties:
@@ -46358,7 +46358,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &620
+ default: &617
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -48281,15 +48281,6 @@ paths:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -48352,8 +48343,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -48366,7 +48355,7 @@ paths:
- updated_at
- url
examples:
- default: &637
+ default: &634
value:
- author:
login: octocat
@@ -48391,8 +48380,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
@@ -48502,8 +48489,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
@@ -48614,7 +48599,7 @@ paths:
application/json:
schema: *307
examples:
- default: &638
+ default: &635
value:
author:
login: octocat
@@ -48639,8 +48624,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
@@ -48695,418 +48678,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:
- - *65
- - *66
- - *309
- - *50
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &310
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- anyOf:
- - type: 'null'
- - *4
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *72
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &639
- 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: *56
- 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:
- - *65
- - *66
- - *309
- 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: *310
- examples:
- default: &311
- 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:
- - *65
- - *66
- - *309
- - &312
- 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: *310
- examples:
- default: *311
- 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:
- - *65
- - *66
- - *309
- - *312
- 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: *310
- examples:
- default: &640
- 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:
- - *65
- - *66
- - *309
- - *312
- 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
@@ -49219,7 +48790,7 @@ paths:
description: Response
content:
application/json:
- schema: &313
+ schema: &310
title: Team Membership
description: Team Membership
type: object
@@ -49247,7 +48818,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &641
+ response-if-user-is-a-team-maintainer: &636
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -49310,9 +48881,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-users-membership-with-team-is-now-pending: &642
+ response-if-users-membership-with-team-is-now-pending: &637
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -49419,14 +48990,14 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &643
+ schema: &638
title: Team Repository
description: A team's access to a repository.
type: object
@@ -50069,8 +49640,8 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -50117,8 +49688,8 @@ paths:
parameters:
- *65
- *66
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -50155,7 +49726,7 @@ paths:
type: array
items: *180
examples:
- response-if-child-teams-exist: &644
+ response-if-child-teams-exist: &639
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -50309,7 +49880,7 @@ paths:
resources:
type: object
properties:
- core: &316
+ core: &313
title: Rate Limit
type: object
properties:
@@ -50326,21 +49897,21 @@ paths:
- remaining
- reset
- used
- graphql: *316
- search: *316
- code_search: *316
- source_import: *316
- integration_manifest: *316
- code_scanning_upload: *316
- actions_runner_registration: *316
- scim: *316
- dependency_snapshots: *316
- dependency_sbom: *316
- code_scanning_autofix: *316
+ graphql: *313
+ search: *313
+ code_search: *313
+ source_import: *313
+ integration_manifest: *313
+ code_scanning_upload: *313
+ actions_runner_registration: *313
+ scim: *313
+ dependency_snapshots: *313
+ dependency_sbom: *313
+ code_scanning_autofix: *313
required:
- core
- search
- rate: *316
+ rate: *313
required:
- rate
- resources
@@ -50445,14 +50016,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
default-response:
summary: Default response
@@ -50953,7 +50524,7 @@ paths:
status: disabled
'403': *27
'404': *6
- '301': *318
+ '301': *315
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50971,8 +50542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -51220,10 +50791,10 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
- '307': &320
+ default: *316
+ '307': &317
description: Temporary Redirect
content:
application/json:
@@ -51252,8 +50823,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -51275,7 +50846,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *320
+ '307': *317
'404': *6
'409': *49
x-github:
@@ -51299,11 +50870,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- - &353
+ - &350
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -51326,7 +50897,7 @@ paths:
type: integer
artifacts:
type: array
- items: &321
+ items: &318
title: Artifact
description: An artifact
type: object
@@ -51421,7 +50992,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &354
+ default: &351
value:
total_count: 2
artifacts:
@@ -51482,9 +51053,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *314
- - *315
- - &322
+ - *311
+ - *312
+ - &319
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -51496,7 +51067,7 @@ paths:
description: Response
content:
application/json:
- schema: *321
+ schema: *318
examples:
default:
value:
@@ -51534,9 +51105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *314
- - *315
- - *322
+ - *311
+ - *312
+ - *319
responses:
'204':
description: Response
@@ -51560,9 +51131,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *314
- - *315
- - *322
+ - *311
+ - *312
+ - *319
- name: archive_format
in: path
required: true
@@ -51576,7 +51147,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': &509
+ '410': &506
description: Gone
content:
application/json:
@@ -51601,14 +51172,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &323
+ schema: &320
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -51642,13 +51213,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *323
+ schema: *320
examples:
selected_actions: *40
responses:
@@ -51677,14 +51248,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &324
+ schema: &321
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -51718,13 +51289,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *324
+ schema: *321
examples:
selected_actions: *42
responses:
@@ -51755,14 +51326,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *325
+ schema: *322
examples:
default:
value:
@@ -51788,11 +51359,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- - &326
+ - &323
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
@@ -51826,7 +51397,7 @@ paths:
description: Response
content:
application/json:
- schema: &327
+ schema: &324
title: Repository actions caches
description: Repository actions caches
type: object
@@ -51876,7 +51447,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &328
+ default: &325
value:
total_count: 1
actions_caches:
@@ -51908,23 +51479,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:
- - *314
- - *315
+ - *311
+ - *312
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *326
+ - *323
responses:
'200':
description: Response
content:
application/json:
- schema: *327
+ schema: *324
examples:
- default: *328
+ default: *325
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51944,8 +51515,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:
- - *314
- - *315
+ - *311
+ - *312
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -51976,9 +51547,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *314
- - *315
- - &329
+ - *311
+ - *312
+ - &326
name: job_id
description: The unique identifier of the job.
in: path
@@ -51990,7 +51561,7 @@ paths:
description: Response
content:
application/json:
- schema: &357
+ schema: &354
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -52337,9 +51908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *314
- - *315
- - *329
+ - *311
+ - *312
+ - *326
responses:
'302':
description: Response
@@ -52367,9 +51938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *314
- - *315
- - *329
+ - *311
+ - *312
+ - *326
requestBody:
required: false
content:
@@ -52415,8 +51986,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Status response
@@ -52466,8 +52037,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -52530,8 +52101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -52549,7 +52120,7 @@ paths:
type: integer
secrets:
type: array
- items: &359
+ items: &356
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -52570,7 +52141,7 @@ paths:
- created_at
- updated_at
examples:
- default: &360
+ default: &357
value:
total_count: 2
secrets:
@@ -52603,9 +52174,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *314
- - *315
- - *330
+ - *311
+ - *312
+ - *327
- *19
responses:
'200':
@@ -52622,7 +52193,7 @@ paths:
type: integer
variables:
type: array
- items: &363
+ items: &360
title: Actions Variable
type: object
properties:
@@ -52656,7 +52227,7 @@ paths:
- created_at
- updated_at
examples:
- default: &364
+ default: &361
value:
total_count: 2
variables:
@@ -52689,8 +52260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -52699,11 +52270,11 @@ paths:
schema:
type: object
properties:
- enabled: &332
+ enabled: &329
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *129
- selected_actions_url: *331
+ selected_actions_url: *328
sha_pinning_required: *130
required:
- enabled
@@ -52732,8 +52303,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -52744,7 +52315,7 @@ paths:
schema:
type: object
properties:
- enabled: *332
+ enabled: *329
allowed_actions: *129
sha_pinning_required: *130
required:
@@ -52776,14 +52347,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &333
+ schema: &330
type: object
properties:
access_level:
@@ -52800,7 +52371,7 @@ paths:
required:
- access_level
examples:
- default: &334
+ default: &331
value:
access_level: organization
x-github:
@@ -52824,15 +52395,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *334
+ default: *331
responses:
'204':
description: Response
@@ -52856,14 +52427,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *335
+ schema: *332
examples:
default:
value:
@@ -52887,8 +52458,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Empty response for successful settings update
@@ -52898,7 +52469,7 @@ paths:
required: true
content:
application/json:
- schema: *336
+ schema: *333
examples:
default:
summary: Set retention days
@@ -52922,8 +52493,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -52931,7 +52502,7 @@ paths:
application/json:
schema: *131
examples:
- default: *337
+ default: *334
'404': *6
x-github:
enabledForGitHubApps: true
@@ -52950,8 +52521,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -52985,14 +52556,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
default: *132
'403': *27
@@ -53014,13 +52585,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *339
+ schema: *336
examples:
default: *132
responses:
@@ -53046,8 +52617,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -53074,8 +52645,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -53107,14 +52678,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
default: *139
x-github:
@@ -53137,8 +52708,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Success response
@@ -53149,7 +52720,7 @@ paths:
required: true
content:
application/json:
- schema: *341
+ schema: *338
examples:
default: *139
x-github:
@@ -53178,8 +52749,8 @@ paths:
in: query
schema:
type: string
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -53223,8 +52794,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -53232,9 +52803,9 @@ paths:
application/json:
schema:
type: array
- items: *342
+ items: *339
examples:
- default: *343
+ default: *340
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53256,8 +52827,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -53300,7 +52871,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *344
+ '201': *341
'404': *6
'422': *7
'409': *49
@@ -53331,8 +52902,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -53340,7 +52911,7 @@ paths:
application/json:
schema: *148
examples:
- default: *345
+ default: *342
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53368,8 +52939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -53377,7 +52948,7 @@ paths:
application/json:
schema: *148
examples:
- default: *346
+ default: *343
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53399,8 +52970,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'200':
@@ -53409,7 +52980,7 @@ paths:
application/json:
schema: *146
examples:
- default: *347
+ default: *344
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53430,8 +53001,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'204':
@@ -53458,8 +53029,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
'200': *150
@@ -53484,8 +53055,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
requestBody:
required: true
@@ -53534,8 +53105,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
requestBody:
required: true
@@ -53585,11 +53156,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
responses:
- '200': *348
+ '200': *345
'404': *6
x-github:
githubCloudOnly: false
@@ -53616,10 +53187,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:
- - *314
- - *315
+ - *311
+ - *312
- *145
- - *349
+ - *346
responses:
'200': *150
'404': *6
@@ -53647,9 +53218,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *314
- - *315
- - &367
+ - *311
+ - *312
+ - &364
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.
@@ -53657,7 +53228,7 @@ paths:
required: false
schema:
type: string
- - &368
+ - &365
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -53665,7 +53236,7 @@ paths:
required: false
schema:
type: string
- - &369
+ - &366
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -53674,7 +53245,7 @@ paths:
required: false
schema:
type: string
- - &370
+ - &367
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
@@ -53701,7 +53272,7 @@ paths:
- pending
- *17
- *19
- - &371
+ - &368
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)."
@@ -53710,7 +53281,7 @@ paths:
schema:
type: string
format: date-time
- - &350
+ - &347
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -53719,13 +53290,13 @@ paths:
schema:
type: boolean
default: false
- - &372
+ - &369
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &373
+ - &370
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -53748,7 +53319,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &351
+ items: &348
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -53926,7 +53497,7 @@ paths:
head_commit:
anyOf:
- type: 'null'
- - &395
+ - &392
title: Simple Commit
description: A commit.
type: object
@@ -54041,7 +53612,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &374
+ default: &371
value:
total_count: 1
workflow_runs:
@@ -54277,24 +53848,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *314
- - *315
- - &352
+ - *311
+ - *312
+ - &349
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *350
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
- default: &355
+ default: &352
value:
id: 30433642
name: Build
@@ -54535,9 +54106,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'204':
description: Response
@@ -54560,9 +54131,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -54690,9 +54261,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:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'201':
description: Response
@@ -54725,12 +54296,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
- *17
- *19
- - *353
+ - *350
responses:
'200':
description: Response
@@ -54746,9 +54317,9 @@ paths:
type: integer
artifacts:
type: array
- items: *321
+ items: *318
examples:
- default: *354
+ default: *351
headers:
Link: *56
x-github:
@@ -54772,25 +54343,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *314
- - *315
- - *352
- - &356
+ - *311
+ - *312
+ - *349
+ - &353
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *350
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
- default: *355
+ default: *352
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -54813,10 +54384,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *314
- - *315
- - *352
- - *356
+ - *311
+ - *312
+ - *349
+ - *353
- *17
- *19
responses:
@@ -54834,9 +54405,9 @@ paths:
type: integer
jobs:
type: array
- items: *357
+ items: *354
examples:
- default: &358
+ default: &355
value:
total_count: 1
jobs:
@@ -54949,10 +54520,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *314
- - *315
- - *352
- - *356
+ - *311
+ - *312
+ - *349
+ - *353
responses:
'302':
description: Response
@@ -54980,9 +54551,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'202':
description: Response
@@ -55015,9 +54586,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:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: true
content:
@@ -55084,9 +54655,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'202':
description: Response
@@ -55119,9 +54690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
- 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
@@ -55151,9 +54722,9 @@ paths:
type: integer
jobs:
type: array
- items: *357
+ items: *354
examples:
- default: *358
+ default: *355
headers:
Link: *56
x-github:
@@ -55178,9 +54749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'302':
description: Response
@@ -55207,9 +54778,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'204':
description: Response
@@ -55236,9 +54807,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -55307,7 +54878,7 @@ paths:
items:
type: object
properties:
- type: &475
+ type: &472
type: string
description: The type of reviewer.
enum:
@@ -55393,9 +54964,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: true
content:
@@ -55445,7 +55016,7 @@ paths:
application/json:
schema:
type: array
- items: &470
+ items: &467
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -55557,7 +55128,7 @@ paths:
- created_at
- updated_at
examples:
- default: &471
+ default: &468
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -55613,9 +55184,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: false
content:
@@ -55660,9 +55231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
requestBody:
required: false
content:
@@ -55716,9 +55287,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *314
- - *315
- - *352
+ - *311
+ - *312
+ - *349
responses:
'200':
description: Response
@@ -55855,8 +55426,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -55874,9 +55445,9 @@ paths:
type: integer
secrets:
type: array
- items: *359
+ items: *356
examples:
- default: *360
+ default: *357
headers:
Link: *56
x-github:
@@ -55901,16 +55472,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55932,17 +55503,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: &488
+ default: &485
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -55968,8 +55539,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -56027,8 +55598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -56054,9 +55625,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *314
- - *315
- - *330
+ - *311
+ - *312
+ - *327
- *19
responses:
'200':
@@ -56073,9 +55644,9 @@ paths:
type: integer
variables:
type: array
- items: *363
+ items: *360
examples:
- default: *364
+ default: *361
headers:
Link: *56
x-github:
@@ -56098,8 +55669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -56151,17 +55722,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
responses:
'200':
description: Response
content:
application/json:
- schema: *363
+ schema: *360
examples:
- default: &489
+ default: &486
value:
name: USERNAME
value: octocat
@@ -56187,8 +55758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
requestBody:
required: true
@@ -56231,8 +55802,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
responses:
'204':
@@ -56258,8 +55829,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -56277,7 +55848,7 @@ paths:
type: integer
workflows:
type: array
- items: &365
+ items: &362
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -56395,9 +55966,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *314
- - *315
- - &366
+ - *311
+ - *312
+ - &363
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -56412,7 +55983,7 @@ paths:
description: Response
content:
application/json:
- schema: *365
+ schema: *362
examples:
default:
value:
@@ -56445,9 +56016,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56472,9 +56043,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56525,9 +56096,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'204':
description: Response
@@ -56554,19 +56125,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *363
+ - *364
+ - *365
- *366
- *367
+ - *17
+ - *19
- *368
+ - *347
- *369
- *370
- - *17
- - *19
- - *371
- - *350
- - *372
- - *373
responses:
'200':
description: Response
@@ -56582,9 +56153,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *351
+ items: *348
examples:
- default: *374
+ default: *371
headers:
Link: *56
x-github:
@@ -56616,9 +56187,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *314
- - *315
- - *366
+ - *311
+ - *312
+ - *363
responses:
'200':
description: Response
@@ -56679,8 +56250,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *50
- *17
- *43
@@ -56848,8 +56419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -56886,8 +56457,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: assignee
in: path
required: true
@@ -56923,8 +56494,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -57036,8 +56607,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *43
- *44
@@ -57094,7 +56665,7 @@ paths:
initiator:
type: string
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57114,8 +56685,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -57123,7 +56694,7 @@ paths:
application/json:
schema:
type: array
- items: &376
+ items: &373
title: Autolink reference
description: An autolink reference.
type: object
@@ -57182,8 +56753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -57222,9 +56793,9 @@ paths:
description: response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: &377
+ default: &374
value:
id: 1
key_prefix: TICKET-
@@ -57255,9 +56826,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *314
- - *315
- - &378
+ - *311
+ - *312
+ - &375
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -57269,9 +56840,9 @@ paths:
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: *377
+ default: *374
'404': *6
x-github:
githubCloudOnly: false
@@ -57291,9 +56862,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *314
- - *315
- - *378
+ - *311
+ - *312
+ - *375
responses:
'204':
description: Response
@@ -57317,8 +56888,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response if Dependabot is enabled
@@ -57368,8 +56939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -57390,8 +56961,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -57411,8 +56982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -57450,7 +57021,7 @@ paths:
- url
protected:
type: boolean
- protection: &380
+ protection: &377
title: Branch Protection
description: Branch Protection
type: object
@@ -57493,7 +57064,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &383
+ enforce_admins: &380
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -57510,7 +57081,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &385
+ required_pull_request_reviews: &382
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -57594,7 +57165,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &382
+ restrictions: &379
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -57887,9 +57458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *314
- - *315
- - &381
+ - *311
+ - *312
+ - &378
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).
@@ -57903,14 +57474,14 @@ paths:
description: Response
content:
application/json:
- schema: &391
+ schema: &388
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &445
+ commit: &442
title: Commit
description: Commit
type: object
@@ -57949,7 +57520,7 @@ paths:
author:
anyOf:
- type: 'null'
- - &379
+ - &376
title: Git User
description: Metaproperties for Git author/committer
information.
@@ -57971,7 +57542,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
message:
type: string
examples:
@@ -57995,7 +57566,7 @@ paths:
required:
- sha
- url
- verification: &495
+ verification: &492
title: Verification
type: object
properties:
@@ -58075,7 +57646,7 @@ paths:
type: integer
files:
type: array
- items: &456
+ items: &453
title: Diff Entry
description: Diff Entry
type: object
@@ -58171,7 +57742,7 @@ paths:
- self
protected:
type: boolean
- protection: *380
+ protection: *377
protection_url:
type: string
format: uri
@@ -58280,7 +57851,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *318
+ '301': *315
'404': *6
x-github:
githubCloudOnly: false
@@ -58302,15 +57873,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *380
+ schema: *377
examples:
default:
value:
@@ -58504,9 +58075,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -58766,7 +58337,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &388
+ required_status_checks: &385
title: Status Check Policy
description: Status Check Policy
type: object
@@ -58925,7 +58496,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *382
+ restrictions: *379
required_conversation_resolution:
type: object
properties:
@@ -59037,9 +58608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59064,17 +58635,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: &384
+ default: &381
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -59096,17 +58667,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: *384
+ default: *381
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59125,9 +58696,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59152,17 +58723,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *385
+ schema: *382
examples:
- default: &386
+ default: &383
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -59258,9 +58829,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59358,9 +58929,9 @@ paths:
description: Response
content:
application/json:
- schema: *385
+ schema: *382
examples:
- default: *386
+ default: *383
'422': *15
x-github:
githubCloudOnly: false
@@ -59381,9 +58952,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59410,17 +58981,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: &387
+ default: &384
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -59443,17 +59014,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *383
+ schema: *380
examples:
- default: *387
+ default: *384
'404': *6
x-github:
githubCloudOnly: false
@@ -59473,9 +59044,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59500,17 +59071,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *388
+ schema: *385
examples:
- default: &389
+ default: &386
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -59536,9 +59107,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59590,9 +59161,9 @@ paths:
description: Response
content:
application/json:
- schema: *388
+ schema: *385
examples:
- default: *389
+ default: *386
'404': *6
'422': *15
x-github:
@@ -59614,9 +59185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -59640,9 +59211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -59676,9 +59247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59745,9 +59316,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -59811,9 +59382,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
content:
application/json:
@@ -59879,15 +59450,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
content:
application/json:
- schema: *382
+ schema: *379
examples:
default:
value:
@@ -59978,9 +59549,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'204':
description: Response
@@ -60003,9 +59574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60015,7 +59586,7 @@ paths:
type: array
items: *5
examples:
- default: &390
+ default: &387
value:
- id: 1
slug: octoapp
@@ -60072,9 +59643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60108,7 +59679,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60129,9 +59700,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60165,7 +59736,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60186,9 +59757,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60222,7 +59793,7 @@ paths:
type: array
items: *5
examples:
- default: *390
+ default: *387
'422': *15
x-github:
githubCloudOnly: false
@@ -60244,9 +59815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60276,9 +59847,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -60337,9 +59908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: false
content:
@@ -60398,9 +59969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
content:
application/json:
@@ -60459,9 +60030,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
responses:
'200':
description: Response
@@ -60495,9 +60066,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60555,9 +60126,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60615,9 +60186,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60677,9 +60248,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
requestBody:
required: true
content:
@@ -60701,7 +60272,7 @@ paths:
description: Response
content:
application/json:
- schema: *391
+ schema: *388
examples:
default:
value:
@@ -60817,8 +60388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -61097,7 +60668,7 @@ paths:
description: Response
content:
application/json:
- schema: &392
+ schema: &389
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -61233,7 +60804,7 @@ paths:
check.
type: array
items: *74
- deployment: &705
+ deployment: &700
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -61520,9 +61091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *314
- - *315
- - &393
+ - *311
+ - *312
+ - &390
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -61534,9 +61105,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: &394
+ default: &391
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -61636,9 +61207,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
requestBody:
required: true
content:
@@ -61878,9 +61449,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: *394
+ default: *391
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61900,9 +61471,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
- *17
- *19
responses:
@@ -62012,9 +61583,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *314
- - *315
- - *393
+ - *311
+ - *312
+ - *390
responses:
'201':
description: Response
@@ -62058,8 +61629,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -62081,7 +61652,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &396
+ schema: &393
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -62179,7 +61750,7 @@ paths:
- string
- 'null'
format: date-time
- head_commit: *395
+ head_commit: *392
latest_check_runs_count:
type: integer
check_runs_url:
@@ -62207,7 +61778,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &397
+ default: &394
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -62498,9 +62069,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62519,8 +62090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -62829,9 +62400,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *314
- - *315
- - &398
+ - *311
+ - *312
+ - &395
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -62843,9 +62414,9 @@ paths:
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62868,17 +62439,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *314
- - *315
- - *398
- - &451
+ - *311
+ - *312
+ - *395
+ - &448
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &452
+ - &449
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -62917,9 +62488,9 @@ paths:
type: integer
check_runs:
type: array
- items: *392
+ items: *389
examples:
- default: &453
+ default: &450
value:
total_count: 1
check_runs:
@@ -63021,9 +62592,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *314
- - *315
- - *398
+ - *311
+ - *312
+ - *395
responses:
'201':
description: Response
@@ -63056,21 +62627,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *314
- - *315
- - *399
- - *400
+ - *311
+ - *312
+ - *396
+ - *397
- *19
- *17
- - &417
+ - &414
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: *401
- - &418
+ schema: *398
+ - &415
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -63095,13 +62666,13 @@ paths:
be returned.
in: query
required: false
- schema: *402
+ schema: *399
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *403
+ schema: *400
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -63125,7 +62696,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: *404
+ instances_url: *401
state: *171
fixed_at: *167
dismissed_by:
@@ -63133,11 +62704,11 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: *405
- dismissed_comment: *406
- rule: *407
- tool: *408
- most_recent_instance: *409
+ dismissed_reason: *402
+ dismissed_comment: *403
+ rule: *404
+ tool: *405
+ most_recent_instance: *406
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -63260,7 +62831,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *35
- '403': &410
+ '403': &407
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -63287,9 +62858,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *314
- - *315
- - &411
+ - *311
+ - *312
+ - &408
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -63303,7 +62874,7 @@ paths:
description: Response
content:
application/json:
- schema: &412
+ schema: &409
type: object
properties:
number: *162
@@ -63311,7 +62882,7 @@ paths:
updated_at: *164
url: *165
html_url: *166
- instances_url: *404
+ instances_url: *401
state: *171
fixed_at: *167
dismissed_by:
@@ -63319,8 +62890,8 @@ paths:
- type: 'null'
- *4
dismissed_at: *168
- dismissed_reason: *405
- dismissed_comment: *406
+ dismissed_reason: *402
+ dismissed_comment: *403
rule:
type: object
properties:
@@ -63382,8 +62953,8 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: *408
- most_recent_instance: *409
+ tool: *405
+ most_recent_instance: *406
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -63479,7 +63050,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *35
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63499,9 +63070,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: true
content:
@@ -63516,8 +63087,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *405
- dismissed_comment: *406
+ dismissed_reason: *402
+ dismissed_comment: *403
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -63545,7 +63116,7 @@ paths:
description: Response
content:
application/json:
- schema: *412
+ schema: *409
examples:
default:
value:
@@ -63621,7 +63192,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &416
+ '403': &413
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -63648,15 +63219,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
responses:
'200':
description: Response
content:
application/json:
- schema: &413
+ schema: &410
type: object
properties:
status:
@@ -63683,13 +63254,13 @@ paths:
- description
- started_at
examples:
- default: &414
+ default: &411
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &415
+ '400': &412
description: Bad Request
content:
application/json:
@@ -63700,7 +63271,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': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63725,29 +63296,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
responses:
'200':
description: OK
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
'202':
description: Accepted
content:
application/json:
- schema: *413
+ schema: *410
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *415
+ '400': *412
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -63779,9 +63350,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:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: false
content:
@@ -63827,8 +63398,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *415
- '403': *416
+ '400': *412
+ '403': *413
'404': *6
'422':
description: Unprocessable Entity
@@ -63852,13 +63423,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
- *19
- *17
- - *417
- - *418
+ - *414
+ - *415
responses:
'200':
description: Response
@@ -63869,10 +63440,10 @@ paths:
items:
type: object
properties:
- ref: *401
- analysis_key: *419
- environment: *420
- category: *421
+ ref: *398
+ analysis_key: *416
+ environment: *417
+ category: *418
state:
type:
- string
@@ -63889,7 +63460,7 @@ paths:
properties:
text:
type: string
- location: *422
+ location: *419
html_url:
type: string
classifications:
@@ -63897,7 +63468,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: *423
+ items: *420
examples:
default:
value:
@@ -63936,7 +63507,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -63970,25 +63541,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *314
- - *315
- - *399
- - *400
+ - *311
+ - *312
+ - *396
+ - *397
- *19
- *17
- - *418
+ - *415
- 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: *401
+ schema: *398
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &424
+ schema: &421
type: string
description: An identifier for the upload.
examples:
@@ -64010,23 +63581,23 @@ paths:
application/json:
schema:
type: array
- items: &425
+ items: &422
type: object
properties:
- ref: *401
- commit_sha: &433
+ ref: *398
+ commit_sha: &430
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: *419
+ analysis_key: *416
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *421
+ category: *418
error:
type: string
examples:
@@ -64051,8 +63622,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *424
- tool: *408
+ sarif_id: *421
+ tool: *405
deletable:
type: boolean
warning:
@@ -64114,7 +63685,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64150,8 +63721,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:
- - *314
- - *315
+ - *311
+ - *312
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -64164,7 +63735,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
response:
summary: application/json response
@@ -64218,7 +63789,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *410
+ '403': *407
'404': *6
'422':
description: Response if analysis could not be processed
@@ -64305,8 +63876,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:
- - *314
- - *315
+ - *311
+ - *312
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -64362,7 +63933,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': *416
+ '403': *413
'404': *6
'503': *105
x-github:
@@ -64384,8 +63955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -64393,7 +63964,7 @@ paths:
application/json:
schema:
type: array
- items: &426
+ items: &423
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -64505,7 +64076,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': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64534,8 +64105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: language
in: path
description: The language of the CodeQL database.
@@ -64547,7 +64118,7 @@ paths:
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -64579,9 +64150,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': &458
+ '302': &455
description: Found
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -64603,8 +64174,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: language
in: path
description: The language of the CodeQL database.
@@ -64614,7 +64185,7 @@ paths:
responses:
'204':
description: Response
- '403': *416
+ '403': *413
'404': *6
'503': *105
x-github:
@@ -64642,8 +64213,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -64652,7 +64223,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &427
+ language: &424
type: string
description: The language targeted by the CodeQL query
enum:
@@ -64732,7 +64303,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &431
+ schema: &428
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -64742,7 +64313,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *55
actor: *4
- query_language: *427
+ query_language: *424
query_pack_url:
type: string
description: The download url for the query pack.
@@ -64790,7 +64361,7 @@ paths:
items:
type: object
properties:
- repository: &428
+ repository: &425
title: Repository Identifier
description: Repository Identifier
type: object
@@ -64832,7 +64403,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &432
+ analysis_status: &429
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -64864,7 +64435,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &429
+ access_mismatch_repos: &426
type: object
properties:
repository_count:
@@ -64879,7 +64450,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: *428
+ items: *425
required:
- repository_count
- repositories
@@ -64902,8 +64473,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *429
- over_limit_repos: *429
+ no_codeql_db_repos: *426
+ over_limit_repos: *426
required:
- access_mismatch_repos
- not_found_repos
@@ -64919,7 +64490,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &430
+ value: &427
summary: Default response
value:
id: 1
@@ -65065,10 +64636,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *430
+ value: *427
repository_lists:
summary: Response for a successful variant analysis submission
- value: *430
+ value: *427
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -65096,8 +64667,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:
- - *314
- - *315
+ - *311
+ - *312
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -65109,9 +64680,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: *430
+ default: *427
'404': *6
'503': *105
x-github:
@@ -65134,7 +64705,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:
- - *314
+ - *311
- name: repo
in: path
description: The name of the controller repository.
@@ -65169,7 +64740,7 @@ paths:
type: object
properties:
repository: *55
- analysis_status: *432
+ analysis_status: *429
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -65294,8 +64865,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -65388,7 +64959,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *410
+ '403': *407
'404': *6
'503': *105
x-github:
@@ -65409,8 +64980,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -65504,7 +65075,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *416
+ '403': *413
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -65575,8 +65146,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -65584,7 +65155,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *433
+ commit_sha: *430
ref:
type: string
description: |-
@@ -65644,7 +65215,7 @@ paths:
schema:
type: object
properties:
- id: *424
+ id: *421
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -65658,7 +65229,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': *416
+ '403': *413
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -65681,8 +65252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -65730,7 +65301,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': *410
+ '403': *407
'404':
description: Not Found if the sarif id does not match any upload
'503': *105
@@ -65755,8 +65326,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -65837,8 +65408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -65966,8 +65537,8 @@ paths:
parameters:
- *17
- *19
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -66281,8 +65852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -66348,7 +65919,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -66356,7 +65927,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'400': *14
'401': *23
'403': *27
@@ -66385,8 +65956,8 @@ paths:
parameters:
- *17
- *19
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -66450,8 +66021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -66488,9 +66059,9 @@ paths:
type: integer
machines:
type: array
- items: *435
+ items: *432
examples:
- default: &651
+ default: &646
value:
total_count: 2
machines:
@@ -66530,8 +66101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -66618,8 +66189,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:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -66688,8 +66259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -66707,7 +66278,7 @@ paths:
type: integer
secrets:
type: array
- items: &439
+ items: &436
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -66728,7 +66299,7 @@ paths:
- created_at
- updated_at
examples:
- default: *436
+ default: *433
headers:
Link: *56
x-github:
@@ -66751,16 +66322,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *437
+ schema: *434
examples:
- default: *438
+ default: *435
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -66780,17 +66351,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66810,8 +66381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -66864,8 +66435,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -66894,8 +66465,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -66933,7 +66504,7 @@ paths:
application/json:
schema:
type: array
- items: &441
+ items: &438
title: Collaborator
description: Collaborator
type: object
@@ -67126,8 +66697,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'204':
@@ -67174,8 +66745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
requestBody:
required: false
@@ -67202,7 +66773,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &508
+ schema: &505
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -67430,8 +67001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'204':
@@ -67463,8 +67034,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *61
responses:
'200':
@@ -67485,7 +67056,7 @@ paths:
user:
anyOf:
- type: 'null'
- - *441
+ - *438
required:
- permission
- role_name
@@ -67539,8 +67110,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -67550,7 +67121,7 @@ paths:
application/json:
schema:
type: array
- items: &442
+ items: &439
title: Commit Comment
description: Commit Comment
type: object
@@ -67608,7 +67179,7 @@ paths:
- created_at
- updated_at
examples:
- default: &447
+ default: &444
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -67667,17 +67238,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: &448
+ default: &445
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -67734,8 +67305,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -67758,7 +67329,7 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
default:
value:
@@ -67809,8 +67380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -67832,8 +67403,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -67860,7 +67431,7 @@ paths:
application/json:
schema:
type: array
- items: &443
+ items: &440
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -67904,7 +67475,7 @@ paths:
- content
- created_at
examples:
- default: &512
+ default: &509
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -67949,8 +67520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -67983,9 +67554,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: &444
+ default: &441
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -68014,9 +67585,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -68038,10 +67609,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - &513
+ - &510
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -68096,8 +67667,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -68153,9 +67724,9 @@ paths:
application/json:
schema:
type: array
- items: *445
+ items: *442
examples:
- default: &559
+ default: &556
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -68249,9 +67820,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *314
- - *315
- - &446
+ - *311
+ - *312
+ - &443
name: commit_sha
description: The SHA of the commit.
in: path
@@ -68323,9 +67894,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
- *17
- *19
responses:
@@ -68335,9 +67906,9 @@ paths:
application/json:
schema:
type: array
- items: *442
+ items: *439
examples:
- default: *447
+ default: *444
headers:
Link: *56
x-github:
@@ -68365,9 +67936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
requestBody:
required: true
content:
@@ -68402,9 +67973,9 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: *448
+ default: *445
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -68432,9 +68003,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
- *17
- *19
responses:
@@ -68444,9 +68015,9 @@ paths:
application/json:
schema:
type: array
- items: *449
+ items: *446
examples:
- default: &551
+ default: &548
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -68983,11 +68554,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
- - &450
+ - &447
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)"
@@ -69002,9 +68573,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: &537
+ default: &534
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -69117,11 +68688,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *314
- - *315
- - *450
- - *451
- - *452
+ - *311
+ - *312
+ - *447
+ - *448
+ - *449
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -69155,9 +68726,9 @@ paths:
type: integer
check_runs:
type: array
- items: *392
+ items: *389
examples:
- default: *453
+ default: *450
headers:
Link: *56
x-github:
@@ -69182,9 +68753,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -69192,7 +68763,7 @@ paths:
schema:
type: integer
example: 1
- - *451
+ - *448
- *17
- *19
responses:
@@ -69210,7 +68781,7 @@ paths:
type: integer
check_suites:
type: array
- items: *396
+ items: *393
examples:
default:
value:
@@ -69410,9 +68981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- *17
- *19
responses:
@@ -69614,9 +69185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *314
- - *315
- - *450
+ - *311
+ - *312
+ - *447
- *17
- *19
responses:
@@ -69626,7 +69197,7 @@ paths:
application/json:
schema:
type: array
- items: &624
+ items: &621
title: Status
description: The status of a commit.
type: object
@@ -69707,7 +69278,7 @@ paths:
site_admin: false
headers:
Link: *56
- '301': *318
+ '301': *315
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69735,8 +69306,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -69769,11 +69340,11 @@ paths:
code_of_conduct:
anyOf:
- type: 'null'
- - *454
+ - *451
code_of_conduct_file:
anyOf:
- type: 'null'
- - &455
+ - &452
title: Community Health File
type: object
properties:
@@ -69793,19 +69364,19 @@ paths:
contributing:
anyOf:
- type: 'null'
- - *455
+ - *452
readme:
anyOf:
- type: 'null'
- - *455
+ - *452
issue_template:
anyOf:
- type: 'null'
- - *455
+ - *452
pull_request_template:
anyOf:
- type: 'null'
- - *455
+ - *452
required:
- code_of_conduct
- code_of_conduct_file
@@ -69934,8 +69505,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
- name: basehead
@@ -69983,8 +69554,8 @@ paths:
format: uri
examples:
- https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *445
- merge_base_commit: *445
+ base_commit: *442
+ merge_base_commit: *442
status:
type: string
enum:
@@ -70008,10 +69579,10 @@ paths:
- 6
commits:
type: array
- items: *445
+ items: *442
files:
type: array
- items: *456
+ items: *453
required:
- url
- html_url
@@ -70297,8 +69868,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -70451,7 +70022,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &457
+ response-if-content-is-a-file: &454
summary: Response if content is a file
value:
type: file
@@ -70588,7 +70159,7 @@ paths:
- size
- type
- url
- - &564
+ - &561
title: Content File
description: Content File
type: object
@@ -70806,7 +70377,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *457
+ response-if-content-is-a-file: *454
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -70875,7 +70446,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *27
- '302': *458
+ '302': *455
'304': *35
x-github:
githubCloudOnly: false
@@ -70898,8 +70469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -70994,7 +70565,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: File Commit
description: File Commit
type: object
@@ -71150,7 +70721,7 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
example-for-creating-a-file:
value:
@@ -71204,7 +70775,7 @@ paths:
schema:
oneOf:
- *3
- - &490
+ - &487
description: Repository rule violation was detected
type: object
properties:
@@ -71225,7 +70796,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &616
+ placeholder_id: &613
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -71257,8 +70828,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: path
description: path parameter
in: path
@@ -71319,7 +70890,7 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
default:
value:
@@ -71374,8 +70945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -71499,8 +71070,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *181
- *182
- *183
@@ -71512,7 +71083,7 @@ paths:
schema:
type: string
- *185
- - *460
+ - *457
- *186
- *187
- *50
@@ -71533,7 +71104,7 @@ paths:
application/json:
schema:
type: array
- items: &464
+ items: &461
type: object
description: A Dependabot alert.
properties:
@@ -71583,7 +71154,7 @@ paths:
- direct
- transitive
-
- security_advisory: *461
+ security_advisory: *458
security_vulnerability: *54
url: *165
html_url: *166
@@ -71614,8 +71185,8 @@ paths:
dismissal.
maxLength: 280
fixed_at: *167
- auto_dismissed_at: *462
- dismissal_request: *463
+ auto_dismissed_at: *459
+ dismissal_request: *460
required:
- number
- state
@@ -71845,9 +71416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *314
- - *315
- - &465
+ - *311
+ - *312
+ - &462
name: alert_number
in: path
description: |-
@@ -71862,7 +71433,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -71975,9 +71546,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *314
- - *315
- - *465
+ - *311
+ - *312
+ - *462
requestBody:
required: true
content:
@@ -72022,7 +71593,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -72151,8 +71722,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -72170,7 +71741,7 @@ paths:
type: integer
secrets:
type: array
- items: &468
+ items: &465
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -72224,16 +71795,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *466
+ schema: *463
examples:
- default: *467
+ default: *464
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72253,15 +71824,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -72287,8 +71858,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
requestBody:
required: true
@@ -72341,8 +71912,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *152
responses:
'204':
@@ -72365,8 +71936,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:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -72540,8 +72111,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -72801,8 +72372,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -72885,7 +72456,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &469
+ metadata: &466
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -72924,7 +72495,7 @@ paths:
examples:
- "/src/build/package-lock.json"
additionalProperties: false
- metadata: *469
+ metadata: *466
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -72938,7 +72509,7 @@ paths:
pattern: "^pkg"
examples:
- pkg:/npm/%40actions/http-client@1.0.11
- metadata: *469
+ metadata: *466
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -73071,8 +72642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -73113,9 +72684,9 @@ paths:
application/json:
schema:
type: array
- items: *470
+ items: *467
examples:
- default: *471
+ default: *468
headers:
Link: *56
x-github:
@@ -73181,8 +72752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -73264,7 +72835,7 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
simple-example:
summary: Simple example
@@ -73337,9 +72908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *314
- - *315
- - &472
+ - *311
+ - *312
+ - &469
name: deployment_id
description: deployment_id parameter
in: path
@@ -73351,7 +72922,7 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
default:
value:
@@ -73416,9 +72987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
responses:
'204':
description: Response
@@ -73440,9 +73011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
- *17
- *19
responses:
@@ -73452,7 +73023,7 @@ paths:
application/json:
schema:
type: array
- items: &473
+ items: &470
title: Deployment Status
description: The status of a deployment.
type: object
@@ -73616,9 +73187,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
requestBody:
required: true
content:
@@ -73693,9 +73264,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *470
examples:
- default: &474
+ default: &471
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -73751,9 +73322,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *314
- - *315
- - *472
+ - *311
+ - *312
+ - *469
- name: status_id
in: path
required: true
@@ -73764,9 +73335,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *470
examples:
- default: *474
+ default: *471
'404': *6
x-github:
githubCloudOnly: false
@@ -73791,8 +73362,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -73849,8 +73420,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -73868,7 +73439,7 @@ paths:
- 5
environments:
type: array
- items: &476
+ items: &473
title: Environment
description: Details of a deployment environment
type: object
@@ -73930,7 +73501,7 @@ paths:
type: string
examples:
- wait_timer
- wait_timer: &478
+ wait_timer: &475
type: integer
description: The amount of time to delay a job after
the job is initially triggered. The time (in minutes)
@@ -73972,7 +73543,7 @@ paths:
items:
type: object
properties:
- type: *475
+ type: *472
reviewer:
anyOf:
- *4
@@ -73999,7 +73570,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &479
+ deployment_branch_policy: &476
type:
- object
- 'null'
@@ -74116,9 +73687,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *314
- - *315
- - &477
+ - *311
+ - *312
+ - &474
name: environment_name
in: path
required: true
@@ -74131,9 +73702,9 @@ paths:
description: Response
content:
application/json:
- schema: *476
+ schema: *473
examples:
- default: &480
+ default: &477
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -74217,9 +73788,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: false
content:
@@ -74229,7 +73800,7 @@ paths:
- object
- 'null'
properties:
- wait_timer: *478
+ wait_timer: *475
prevent_self_review:
type: boolean
description: Whether or not a user who created the job is prevented
@@ -74248,14 +73819,14 @@ paths:
items:
type: object
properties:
- type: *475
+ type: *472
id:
type: integer
description: The id of the user or team who can review the
deployment
examples:
- 4532992
- deployment_branch_policy: *479
+ deployment_branch_policy: *476
additionalProperties: false
examples:
default:
@@ -74275,9 +73846,9 @@ paths:
description: Response
content:
application/json:
- schema: *476
+ schema: *473
examples:
- default: *480
+ default: *477
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -74301,9 +73872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
responses:
'204':
description: Default response
@@ -74328,9 +73899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *17
- *19
responses:
@@ -74349,7 +73920,7 @@ paths:
- 2
branch_policies:
type: array
- items: &481
+ items: &478
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -74410,9 +73981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: true
content:
@@ -74460,9 +74031,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- example-wildcard: &482
+ example-wildcard: &479
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -74504,10 +74075,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - &483
+ - *311
+ - *312
+ - *474
+ - &480
name: branch_policy_id
in: path
required: true
@@ -74519,9 +74090,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- default: *482
+ default: *479
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74540,10 +74111,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - *483
+ - *311
+ - *312
+ - *474
+ - *480
requestBody:
required: true
content:
@@ -74572,9 +74143,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- default: *482
+ default: *479
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74593,10 +74164,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *314
- - *315
- - *477
- - *483
+ - *311
+ - *312
+ - *474
+ - *480
responses:
'204':
description: Response
@@ -74621,9 +74192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
responses:
'200':
description: List of deployment protection rules
@@ -74640,7 +74211,7 @@ paths:
- 10
custom_deployment_protection_rules:
type: array
- items: &484
+ items: &481
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -74662,7 +74233,7 @@ paths:
for the environment.
examples:
- true
- app: &485
+ app: &482
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -74765,9 +74336,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:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
requestBody:
content:
application/json:
@@ -74788,9 +74359,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: &486
+ default: &483
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -74825,9 +74396,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:
- - *477
- - *315
- - *314
+ - *474
+ - *312
+ - *311
- *19
- *17
responses:
@@ -74847,7 +74418,7 @@ paths:
- 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *485
+ items: *482
examples:
default:
value:
@@ -74882,10 +74453,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *314
- - *315
- - *477
- - &487
+ - *311
+ - *312
+ - *474
+ - &484
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -74897,9 +74468,9 @@ paths:
description: Response
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: *486
+ default: *483
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74920,10 +74491,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *477
- - *315
- - *314
- - *487
+ - *474
+ - *312
+ - *311
+ - *484
responses:
'204':
description: Response
@@ -74949,9 +74520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *17
- *19
responses:
@@ -74969,9 +74540,9 @@ paths:
type: integer
secrets:
type: array
- items: *359
+ items: *356
examples:
- default: *360
+ default: *357
headers:
Link: *56
x-github:
@@ -74996,17 +74567,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75028,18 +74599,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: *488
+ default: *485
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75061,9 +74632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
requestBody:
required: true
@@ -75121,9 +74692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *152
responses:
'204':
@@ -75149,10 +74720,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *314
- - *315
- - *477
- - *330
+ - *311
+ - *312
+ - *474
+ - *327
- *19
responses:
'200':
@@ -75169,9 +74740,9 @@ paths:
type: integer
variables:
type: array
- items: *363
+ items: *360
examples:
- default: *364
+ default: *361
headers:
Link: *56
x-github:
@@ -75194,9 +74765,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
requestBody:
required: true
content:
@@ -75248,18 +74819,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *314
- - *315
- - *477
+ - *311
+ - *312
+ - *474
- *155
responses:
'200':
description: Response
content:
application/json:
- schema: *363
+ schema: *360
examples:
- default: *489
+ default: *486
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75280,10 +74851,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
- - *477
+ - *474
requestBody:
required: true
content:
@@ -75325,10 +74896,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *155
- - *477
+ - *474
responses:
'204':
description: Response
@@ -75350,8 +74921,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -75419,8 +74990,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -75579,8 +75150,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -75613,9 +75184,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
'400': *14
'422': *15
'403': *27
@@ -75636,8 +75207,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -75697,7 +75268,7 @@ paths:
schema:
oneOf:
- *113
- - *490
+ - *487
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75722,8 +75293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: file_sha
in: path
required: true
@@ -75823,8 +75394,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -75933,7 +75504,7 @@ paths:
description: Response
content:
application/json:
- schema: &491
+ schema: &488
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -76160,15 +75731,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *314
- - *315
- - *446
+ - *311
+ - *312
+ - *443
responses:
'200':
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
default:
value:
@@ -76224,9 +75795,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *314
- - *315
- - &492
+ - *311
+ - *312
+ - &489
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.
@@ -76243,7 +75814,7 @@ paths:
application/json:
schema:
type: array
- items: &493
+ items: &490
title: Git Reference
description: Git references within a repository
type: object
@@ -76319,17 +75890,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: &494
+ default: &491
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -76358,8 +75929,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76388,9 +75959,9 @@ paths:
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *494
+ default: *491
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -76416,9 +75987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
requestBody:
required: true
content:
@@ -76447,9 +76018,9 @@ paths:
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *494
+ default: *491
'422': *15
'409': *49
x-github:
@@ -76467,9 +76038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *314
- - *315
- - *492
+ - *311
+ - *312
+ - *489
responses:
'204':
description: Response
@@ -76524,8 +76095,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76592,7 +76163,7 @@ paths:
description: Response
content:
application/json:
- schema: &496
+ schema: &493
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -76648,7 +76219,7 @@ paths:
- sha
- type
- url
- verification: *495
+ verification: *492
required:
- sha
- url
@@ -76658,7 +76229,7 @@ paths:
- tag
- message
examples:
- default: &497
+ default: &494
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -76731,8 +76302,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tag_sha
in: path
required: true
@@ -76743,9 +76314,9 @@ paths:
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
- default: *497
+ default: *494
'404': *6
'409': *49
x-github:
@@ -76769,8 +76340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -76844,7 +76415,7 @@ paths:
description: Response
content:
application/json:
- schema: &498
+ schema: &495
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -76946,8 +76517,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -76970,7 +76541,7 @@ paths:
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
default-response:
summary: Default response
@@ -77029,8 +76600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -77040,7 +76611,7 @@ paths:
application/json:
schema:
type: array
- items: &499
+ items: &496
title: Webhook
description: Webhooks for repositories.
type: object
@@ -77103,7 +76674,7 @@ paths:
format: uri
examples:
- https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &736
+ last_response: &731
title: Hook Response
type: object
properties:
@@ -77180,8 +76751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -77234,9 +76805,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &500
+ default: &497
value:
type: Repository
id: 12345678
@@ -77284,17 +76855,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
'404': *6
x-github:
githubCloudOnly: false
@@ -77314,8 +76885,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
requestBody:
required: true
@@ -77361,9 +76932,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
'422': *15
'404': *6
x-github:
@@ -77384,8 +76955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77410,8 +76981,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'200':
@@ -77439,8 +77010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
requestBody:
required: false
@@ -77485,8 +77056,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *17
- *194
@@ -77518,8 +77089,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *16
responses:
@@ -77548,8 +77119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
- *16
responses:
@@ -77573,8 +77144,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77600,8 +77171,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *193
responses:
'204':
@@ -77625,8 +77196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response if immutable releases are enabled
@@ -77674,8 +77245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'409': *49
@@ -77695,8 +77266,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'409': *49
@@ -77753,14 +77324,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &501
+ schema: &498
title: Import
description: A repository import from an external source.
type: object
@@ -77867,7 +77438,7 @@ paths:
- html_url
- authors_url
examples:
- default: &504
+ default: &501
value:
vcs: subversion
use_lfs: true
@@ -77883,7 +77454,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': &502
+ '503': &499
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -77912,8 +77483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -77961,7 +77532,7 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
default:
value:
@@ -77986,7 +77557,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78014,8 +77585,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -78067,7 +77638,7 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
example-1:
summary: Example 1
@@ -78115,7 +77686,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': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78138,12 +77709,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78169,9 +77740,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *314
- - *315
- - &672
+ - *311
+ - *312
+ - &667
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -78185,7 +77756,7 @@ paths:
application/json:
schema:
type: array
- items: &503
+ items: &500
title: Porter Author
description: Porter Author
type: object
@@ -78239,7 +77810,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': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78264,8 +77835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: author_id
in: path
required: true
@@ -78295,7 +77866,7 @@ paths:
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
default:
value:
@@ -78308,7 +77879,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78332,8 +77903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78374,7 +77945,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78402,8 +77973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -78430,11 +78001,11 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: *504
+ default: *501
'422': *15
- '503': *502
+ '503': *499
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78457,8 +78028,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78466,8 +78037,8 @@ paths:
application/json:
schema: *20
examples:
- default: *505
- '301': *318
+ default: *502
+ '301': *315
'404': *6
x-github:
githubCloudOnly: false
@@ -78487,8 +78058,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -78501,7 +78072,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &507
+ default: &504
value:
limit: collaborators_only
origin: repository
@@ -78526,13 +78097,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
application/json:
- schema: *506
+ schema: *503
examples:
default:
summary: Example request body
@@ -78546,7 +78117,7 @@ paths:
application/json:
schema: *211
examples:
- default: *507
+ default: *504
'409':
description: Response
x-github:
@@ -78568,8 +78139,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -78592,8 +78163,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -78603,9 +78174,9 @@ paths:
application/json:
schema:
type: array
- items: *508
+ items: *505
examples:
- default: &665
+ default: &660
value:
- id: 1
repository:
@@ -78736,8 +78307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *215
requestBody:
required: false
@@ -78767,7 +78338,7 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
default:
value:
@@ -78898,8 +78469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *215
responses:
'204':
@@ -78931,8 +78502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *314
- - *315
+ - *311
+ - *312
- 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
@@ -79005,7 +78576,7 @@ paths:
type: array
items: *70
examples:
- default: &518
+ default: &515
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -79153,7 +78724,7 @@ paths:
state_reason: completed
headers:
Link: *56
- '301': *318
+ '301': *315
'422': *15
'404': *6
x-github:
@@ -79182,8 +78753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -79275,7 +78846,7 @@ paths:
application/json:
schema: *70
examples:
- default: &515
+ default: &512
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -79431,7 +79002,7 @@ paths:
'422': *15
'503': *105
'404': *6
- '410': *509
+ '410': *506
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -79459,8 +79030,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *93
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -79481,9 +79052,9 @@ paths:
application/json:
schema:
type: array
- items: *510
+ items: *507
examples:
- default: &517
+ default: &514
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -79541,17 +79112,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: &511
+ default: &508
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -79605,8 +79176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -79629,9 +79200,9 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
'422': *15
x-github:
githubCloudOnly: false
@@ -79649,8 +79220,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -79671,8 +79242,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -79699,9 +79270,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -79722,8 +79293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -79756,16 +79327,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -79787,10 +79358,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - *513
+ - *510
responses:
'204':
description: Response
@@ -79810,8 +79381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -79821,7 +79392,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Issue Event
description: Issue Event
type: object
@@ -80160,8 +79731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: event_id
in: path
required: true
@@ -80172,7 +79743,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -80364,7 +79935,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *509
+ '410': *506
'403': *27
x-github:
githubCloudOnly: false
@@ -80398,9 +79969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *314
- - *315
- - &516
+ - *311
+ - *312
+ - &513
name: issue_number
description: The number that identifies the issue.
in: path
@@ -80414,10 +79985,10 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'304': *35
x-github:
githubCloudOnly: false
@@ -80442,9 +80013,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -80565,13 +80136,13 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
'422': *15
'503': *105
'403': *27
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80589,9 +80160,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -80619,7 +80190,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80635,9 +80206,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
content:
application/json:
@@ -80664,7 +80235,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80686,9 +80257,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:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: assignee
in: path
required: true
@@ -80728,9 +80299,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *76
- *17
- *19
@@ -80741,13 +80312,13 @@ paths:
application/json:
schema:
type: array
- items: *510
+ items: *507
examples:
- default: *517
+ default: *514
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80776,9 +80347,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -80800,16 +80371,16 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -80837,9 +80408,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -80851,12 +80422,12 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80884,9 +80455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -80910,15 +80481,15 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *318
+ '301': *315
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -80949,9 +80520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -80965,13 +80536,13 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'400': *14
'401': *23
'403': *27
'404': *6
- '410': *509
+ '410': *506
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -80997,9 +80568,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81011,12 +80582,12 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81033,9 +80604,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81049,7 +80620,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &520
+ - &517
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -81098,7 +80669,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &521
+ - &518
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -81226,7 +80797,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &522
+ - &519
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -81272,7 +80843,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &523
+ - &520
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -81318,7 +80889,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &524
+ - &521
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -81367,7 +80938,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &525
+ - &522
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -81409,7 +80980,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &526
+ - &523
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -81451,7 +81022,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &527
+ - &524
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -81507,7 +81078,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &528
+ - &525
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -81552,7 +81123,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &529
+ - &526
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -81613,7 +81184,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &530
+ - &527
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -81674,7 +81245,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &531
+ - &528
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -81735,7 +81306,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &532
+ - &529
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -81828,7 +81399,7 @@ paths:
color: red
headers:
Link: *56
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81845,9 +81416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -81859,7 +81430,7 @@ paths:
type: array
items: *69
examples:
- default: &519
+ default: &516
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81877,9 +81448,9 @@ paths:
default: false
headers:
Link: *56
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81896,9 +81467,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -81959,10 +81530,10 @@ paths:
type: array
items: *69
examples:
- default: *519
- '301': *318
+ default: *516
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'422': *15
x-github:
githubCloudOnly: false
@@ -81979,9 +81550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -82043,10 +81614,10 @@ paths:
type: array
items: *69
examples:
- default: *519
- '301': *318
+ default: *516
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
'422': *15
x-github:
githubCloudOnly: false
@@ -82063,15 +81634,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'204':
description: Response
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82090,9 +81661,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- name: name
in: path
required: true
@@ -82116,9 +81687,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *318
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82138,9 +81709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: false
content:
@@ -82169,7 +81740,7 @@ paths:
'204':
description: Response
'403': *27
- '410': *509
+ '410': *506
'404': *6
'422': *15
x-github:
@@ -82187,9 +81758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'204':
description: Response
@@ -82219,9 +81790,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
responses:
'200':
description: Response
@@ -82229,10 +81800,10 @@ paths:
application/json:
schema: *70
examples:
- default: *515
- '301': *318
+ default: *512
+ '301': *315
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82249,9 +81820,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- 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.
@@ -82277,13 +81848,13 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82301,9 +81872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82335,16 +81906,16 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -82366,10 +81937,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
- *513
+ - *510
responses:
'204':
description: Response
@@ -82398,9 +81969,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82424,7 +81995,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -82457,9 +82028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -82471,11 +82042,11 @@ paths:
type: array
items: *70
examples:
- default: *518
+ default: *515
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82503,9 +82074,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82534,14 +82105,14 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *27
- '410': *509
+ '410': *506
'422': *15
'404': *6
x-github:
@@ -82561,9 +82132,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
requestBody:
required: true
content:
@@ -82596,7 +82167,7 @@ paths:
application/json:
schema: *70
examples:
- default: *515
+ default: *512
'403': *27
'404': *6
'422': *7
@@ -82618,9 +82189,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *314
- - *315
- - *516
+ - *311
+ - *312
+ - *513
- *17
- *19
responses:
@@ -82635,6 +82206,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *517
+ - *518
+ - *519
- *520
- *521
- *522
@@ -82645,9 +82219,6 @@ paths:
- *527
- *528
- *529
- - *530
- - *531
- - *532
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -82976,7 +82547,7 @@ paths:
type: string
comments:
type: array
- items: &553
+ items: &550
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -83214,7 +82785,7 @@ paths:
type: string
comments:
type: array
- items: *442
+ items: *439
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -83489,7 +83060,7 @@ paths:
headers:
Link: *56
'404': *6
- '410': *509
+ '410': *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -83506,8 +83077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -83517,7 +83088,7 @@ paths:
application/json:
schema:
type: array
- items: &533
+ items: &530
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -83585,8 +83156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -83622,9 +83193,9 @@ paths:
description: Response
content:
application/json:
- schema: *533
+ schema: *530
examples:
- default: &534
+ default: &531
value:
id: 1
key: ssh-rsa AAA...
@@ -83658,9 +83229,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *314
- - *315
- - &535
+ - *311
+ - *312
+ - &532
name: key_id
description: The unique identifier of the key.
in: path
@@ -83672,9 +83243,9 @@ paths:
description: Response
content:
application/json:
- schema: *533
+ schema: *530
examples:
- default: *534
+ default: *531
'404': *6
x-github:
githubCloudOnly: false
@@ -83692,9 +83263,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *314
- - *315
- - *535
+ - *311
+ - *312
+ - *532
responses:
'204':
description: Response
@@ -83714,8 +83285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -83727,7 +83298,7 @@ paths:
type: array
items: *69
examples:
- default: *519
+ default: *516
headers:
Link: *56
'404': *6
@@ -83748,8 +83319,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -83787,7 +83358,7 @@ paths:
application/json:
schema: *69
examples:
- default: &536
+ default: &533
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -83819,8 +83390,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83833,7 +83404,7 @@ paths:
application/json:
schema: *69
examples:
- default: *536
+ default: *533
'404': *6
x-github:
githubCloudOnly: false
@@ -83850,8 +83421,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83916,8 +83487,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: name
in: path
required: true
@@ -83943,8 +83514,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -83983,9 +83554,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *314
- - *315
- - *417
+ - *311
+ - *312
+ - *414
responses:
'200':
description: Response
@@ -84132,8 +83703,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84198,8 +83769,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84233,9 +83804,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: *537
+ default: *534
'204':
description: Response when already merged
'404':
@@ -84260,8 +83831,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -84358,8 +83929,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84401,7 +83972,7 @@ paths:
application/json:
schema: *252
examples:
- default: &538
+ default: &535
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -84460,9 +84031,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *314
- - *315
- - &539
+ - *311
+ - *312
+ - &536
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -84476,7 +84047,7 @@ paths:
application/json:
schema: *252
examples:
- default: *538
+ default: *535
'404': *6
x-github:
githubCloudOnly: false
@@ -84493,9 +84064,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
requestBody:
required: false
content:
@@ -84535,7 +84106,7 @@ paths:
application/json:
schema: *252
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84551,9 +84122,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
responses:
'204':
description: Response
@@ -84574,9 +84145,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *314
- - *315
- - *539
+ - *311
+ - *312
+ - *536
- *17
- *19
responses:
@@ -84588,7 +84159,7 @@ paths:
type: array
items: *69
examples:
- default: *519
+ default: *516
headers:
Link: *56
x-github:
@@ -84607,12 +84178,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *314
- - *315
- - *540
- - *541
+ - *311
+ - *312
+ - *537
+ - *538
- *76
- - *542
+ - *539
- *17
- *19
responses:
@@ -84624,7 +84195,7 @@ paths:
type: array
items: *96
examples:
- default: *543
+ default: *540
headers:
Link: *56
x-github:
@@ -84648,8 +84219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -84707,14 +84278,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: &544
+ schema: &541
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -84858,7 +84429,7 @@ paths:
- custom_404
- public
examples:
- default: &545
+ default: &542
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -84899,8 +84470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -84955,9 +84526,9 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
- default: *545
+ default: *542
'422': *15
'409': *49
x-github:
@@ -84980,8 +84551,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85081,8 +84652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -85108,8 +84679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -85119,7 +84690,7 @@ paths:
application/json:
schema:
type: array
- items: &546
+ items: &543
title: Page Build
description: Page Build
type: object
@@ -85211,8 +84782,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'201':
description: Response
@@ -85259,16 +84830,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
- default: &547
+ default: &544
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -85316,8 +84887,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: build_id
in: path
required: true
@@ -85328,9 +84899,9 @@ paths:
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
- default: *547
+ default: *544
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85350,8 +84921,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85459,9 +85030,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *314
- - *315
- - &548
+ - *311
+ - *312
+ - &545
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -85519,9 +85090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *314
- - *315
- - *548
+ - *311
+ - *312
+ - *545
responses:
'204': *176
'404': *6
@@ -85548,8 +85119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -85844,8 +85415,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Private vulnerability reporting status
@@ -85882,8 +85453,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'422': *14
@@ -85904,8 +85475,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204': *176
'422': *14
@@ -85927,8 +85498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -85938,7 +85509,7 @@ paths:
type: array
items: *103
examples:
- default: *549
+ default: *546
'403': *27
'404': *6
x-github:
@@ -85960,8 +85531,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -85977,7 +85548,7 @@ paths:
required:
- properties
examples:
- default: *550
+ default: *547
responses:
'204':
description: No Content when custom property values are successfully created
@@ -86015,8 +85586,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -86076,9 +85647,9 @@ paths:
application/json:
schema:
type: array
- items: *449
+ items: *446
examples:
- default: *551
+ default: *548
headers:
Link: *56
'304': *35
@@ -86110,8 +85681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -86178,7 +85749,7 @@ paths:
description: Response
content:
application/json:
- schema: &555
+ schema: &552
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -86418,7 +85989,7 @@ paths:
- review_comment
- self
author_association: *71
- auto_merge: *552
+ auto_merge: *549
draft:
description: Indicates whether or not the pull request is a draft.
type: boolean
@@ -86520,7 +86091,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &556
+ default: &553
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -87047,8 +86618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sort
in: query
required: false
@@ -87077,9 +86648,9 @@ paths:
application/json:
schema:
type: array
- items: *553
+ items: *550
examples:
- default: &558
+ default: &555
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -87156,17 +86727,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'200':
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: &554
+ default: &551
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -87241,8 +86812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -87265,9 +86836,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: *554
+ default: *551
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87283,8 +86854,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
responses:
'204':
@@ -87306,8 +86877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -87334,9 +86905,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -87357,8 +86928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
requestBody:
required: true
@@ -87391,16 +86962,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -87422,10 +86993,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *85
- - *513
+ - *510
responses:
'204':
description: Response
@@ -87468,9 +87039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *314
- - *315
- - &557
+ - *311
+ - *312
+ - &554
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -87483,9 +87054,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *556
+ default: *553
'304': *35
'404': *6
'406':
@@ -87520,9 +87091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -87564,9 +87135,9 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *556
+ default: *553
'422': *15
'403': *27
x-github:
@@ -87588,9 +87159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -87653,7 +87224,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -87661,7 +87232,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -87691,9 +87262,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *93
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -87714,9 +87285,9 @@ paths:
application/json:
schema:
type: array
- items: *553
+ items: *550
examples:
- default: *558
+ default: *555
headers:
Link: *56
x-github:
@@ -87749,9 +87320,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -87857,7 +87428,7 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
example-for-a-multi-line-comment:
value:
@@ -87945,9 +87516,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *85
requestBody:
required: true
@@ -87970,7 +87541,7 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
default:
value:
@@ -88056,9 +87627,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -88068,9 +87639,9 @@ paths:
application/json:
schema:
type: array
- items: *445
+ items: *442
examples:
- default: *559
+ default: *556
headers:
Link: *56
x-github:
@@ -88100,9 +87671,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -88112,7 +87683,7 @@ paths:
application/json:
schema:
type: array
- items: *456
+ items: *453
examples:
default:
value:
@@ -88150,9 +87721,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
responses:
'204':
description: Response if pull request has been merged
@@ -88175,9 +87746,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -88289,9 +87860,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
responses:
'200':
description: Response
@@ -88366,9 +87937,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -88405,7 +87976,7 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -88941,9 +88512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: true
content:
@@ -88977,7 +88548,7 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -89482,9 +89053,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
- *17
- *19
responses:
@@ -89494,7 +89065,7 @@ paths:
application/json:
schema:
type: array
- items: &560
+ items: &557
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -89650,9 +89221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -89742,9 +89313,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: &562
+ default: &559
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -89807,10 +89378,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - &561
+ - *311
+ - *312
+ - *554
+ - &558
name: review_id
description: The unique identifier of the review.
in: path
@@ -89822,9 +89393,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: &563
+ default: &560
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -89883,10 +89454,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -89909,7 +89480,7 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
default:
value:
@@ -89971,18 +89542,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
responses:
'200':
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *562
+ default: *559
'422': *7
'404': *6
x-github:
@@ -90009,10 +89580,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
- *17
- *19
responses:
@@ -90270,10 +89841,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -90302,7 +89873,7 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
default:
value:
@@ -90365,10 +89936,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *314
- - *315
- - *557
- - *561
+ - *311
+ - *312
+ - *554
+ - *558
requestBody:
required: true
content:
@@ -90403,9 +89974,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *563
+ default: *560
'404': *6
'422': *7
'403': *27
@@ -90427,9 +89998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *314
- - *315
- - *557
+ - *311
+ - *312
+ - *554
requestBody:
required: false
content:
@@ -90493,8 +90064,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -90507,9 +90078,9 @@ paths:
description: Response
content:
application/json:
- schema: *564
+ schema: *561
examples:
- default: &565
+ default: &562
value:
type: file
encoding: base64
@@ -90551,8 +90122,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: dir
description: The alternate path to look for a README file
in: path
@@ -90572,9 +90143,9 @@ paths:
description: Response
content:
application/json:
- schema: *564
+ schema: *561
examples:
- default: *565
+ default: *562
'404': *6
'422': *15
x-github:
@@ -90596,8 +90167,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -90607,7 +90178,7 @@ paths:
application/json:
schema:
type: array
- items: *566
+ items: *563
examples:
default:
value:
@@ -90701,8 +90272,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -90778,9 +90349,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: &570
+ default: &567
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -90885,9 +90456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *314
- - *315
- - &568
+ - *311
+ - *312
+ - &565
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -90899,9 +90470,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: &569
+ default: &566
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
@@ -90936,7 +90507,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *458
+ '302': *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -90952,9 +90523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *314
- - *315
- - *568
+ - *311
+ - *312
+ - *565
requestBody:
required: false
content:
@@ -90983,9 +90554,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *569
+ default: *566
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91001,9 +90572,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *314
- - *315
- - *568
+ - *311
+ - *312
+ - *565
responses:
'204':
description: Response
@@ -91027,8 +90598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -91114,16 +90685,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91140,8 +90711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: tag
description: tag parameter
in: path
@@ -91154,9 +90725,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'404': *6
x-github:
githubCloudOnly: false
@@ -91178,9 +90749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *314
- - *315
- - &571
+ - *311
+ - *312
+ - &568
name: release_id
description: The unique identifier of the release.
in: path
@@ -91194,9 +90765,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: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'401':
description: Unauthorized
x-github:
@@ -91214,9 +90785,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
requestBody:
required: false
content:
@@ -91280,9 +90851,9 @@ paths:
description: Response
content:
application/json:
- schema: *566
+ schema: *563
examples:
- default: *570
+ default: *567
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -91303,9 +90874,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
responses:
'204':
description: Response
@@ -91325,9 +90896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- *17
- *19
responses:
@@ -91337,7 +90908,7 @@ paths:
application/json:
schema:
type: array
- items: *567
+ items: *564
examples:
default:
value:
@@ -91418,9 +90989,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:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- name: name
in: query
required: true
@@ -91446,7 +91017,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *567
+ schema: *564
examples:
response-for-successful-upload:
value:
@@ -91501,9 +91072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
- 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.
@@ -91527,9 +91098,9 @@ paths:
application/json:
schema:
type: array
- items: *443
+ items: *440
examples:
- default: *512
+ default: *509
headers:
Link: *56
'404': *6
@@ -91550,9 +91121,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *314
- - *315
- - *571
+ - *311
+ - *312
+ - *568
requestBody:
required: true
content:
@@ -91582,16 +91153,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'201':
description: Reaction created
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *15
x-github:
githubCloudOnly: false
@@ -91613,10 +91184,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *314
- - *315
- - *571
- - *513
+ - *311
+ - *312
+ - *568
+ - *510
responses:
'204':
description: Response
@@ -91640,9 +91211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *314
- - *315
- - *381
+ - *311
+ - *312
+ - *378
- *17
- *19
responses:
@@ -91659,7 +91230,7 @@ paths:
oneOf:
- allOf:
- *271
- - &572
+ - &569
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -91680,67 +91251,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *272
- - *572
+ - *569
- allOf:
- *273
- - *572
+ - *569
- allOf:
- *274
- - *572
+ - *569
- allOf:
- - *573
- - *572
+ - *570
+ - *569
- allOf:
- *275
- - *572
+ - *569
- allOf:
- *276
- - *572
+ - *569
- allOf:
- *277
- - *572
+ - *569
- allOf:
- *278
- - *572
+ - *569
- allOf:
- *279
- - *572
+ - *569
- allOf:
- *280
- - *572
+ - *569
- allOf:
- *281
- - *572
+ - *569
- allOf:
- *282
- - *572
+ - *569
- allOf:
- *283
- - *572
+ - *569
- allOf:
- *284
- - *572
+ - *569
- allOf:
- *285
- - *572
+ - *569
- allOf:
- *286
- - *572
+ - *569
- allOf:
- *287
- - *572
+ - *569
- allOf:
- *288
- - *572
+ - *569
- allOf:
- *289
- - *572
+ - *569
- allOf:
- *290
- - *572
+ - *569
- allOf:
- *291
- - *572
+ - *569
examples:
default:
value:
@@ -91779,8 +91350,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- name: includes_parents
@@ -91791,7 +91362,7 @@ paths:
schema:
type: boolean
default: true
- - *574
+ - *571
responses:
'200':
description: Response
@@ -91846,8 +91417,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
description: Request body
required: true
@@ -91876,7 +91447,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *575
+ items: *572
required:
- name
- enforcement
@@ -91909,7 +91480,7 @@ paths:
application/json:
schema: *292
examples:
- default: &585
+ default: &582
value:
id: 42
name: super cool ruleset
@@ -91956,12 +91527,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *573
+ - *574
+ - *575
- *576
- - *577
- - *578
- - *579
- *17
- *19
responses:
@@ -91969,9 +91540,9 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
- default: *581
+ default: *578
'404': *6
'500': *104
x-github:
@@ -91992,17 +91563,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *314
- - *315
- - *582
+ - *311
+ - *312
+ - *579
responses:
'200':
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
- default: *584
+ default: *581
'404': *6
'500': *104
x-github:
@@ -92030,8 +91601,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92053,7 +91624,7 @@ paths:
application/json:
schema: *292
examples:
- default: *585
+ default: *582
'404': *6
'500': *104
put:
@@ -92071,8 +91642,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92106,7 +91677,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *575
+ items: *572
examples:
default:
value:
@@ -92136,7 +91707,7 @@ paths:
application/json:
schema: *292
examples:
- default: *585
+ default: *582
'404': *6
'500': *104
delete:
@@ -92154,8 +91725,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92178,8 +91749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
- name: ruleset_id
@@ -92197,7 +91768,7 @@ paths:
type: array
items: *295
examples:
- default: *586
+ default: *583
'404': *6
'500': *104
x-github:
@@ -92216,8 +91787,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -92235,7 +91806,7 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
default:
value:
@@ -92290,22 +91861,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
+ - *585
+ - *586
+ - *587
- *588
- *589
- - *590
- - *591
- - *592
- *50
- *19
- *17
+ - *590
+ - *591
+ - *592
- *593
- *594
- *595
- - *596
- - *597
- - *598
responses:
'200':
description: Response
@@ -92313,7 +91884,7 @@ paths:
application/json:
schema:
type: array
- items: &602
+ items: &599
type: object
properties:
number: *162
@@ -92329,8 +91900,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *599
- resolution: *600
+ state: *596
+ resolution: *597
resolved_at:
type:
- string
@@ -92424,7 +91995,7 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - *601
+ - *598
has_more_locations:
type: boolean
description: A boolean value representing whether or not the
@@ -92569,16 +92140,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
- - *598
+ - *311
+ - *312
+ - *408
+ - *595
responses:
'200':
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
default:
value:
@@ -92632,9 +92203,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
requestBody:
required: true
content:
@@ -92642,8 +92213,8 @@ paths:
schema:
type: object
properties:
- state: *599
- resolution: *600
+ state: *596
+ resolution: *597
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -92679,7 +92250,7 @@ paths:
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
default:
value:
@@ -92774,9 +92345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *314
- - *315
- - *411
+ - *311
+ - *312
+ - *408
- *19
- *17
responses:
@@ -92787,7 +92358,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &756
+ items: &751
type: object
properties:
type:
@@ -92814,6 +92385,9 @@ paths:
- commit
details:
oneOf:
+ - *600
+ - *601
+ - *602
- *603
- *604
- *605
@@ -92824,9 +92398,6 @@ paths:
- *610
- *611
- *612
- - *613
- - *614
- - *615
examples:
default:
value:
@@ -92912,8 +92483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -92921,14 +92492,14 @@ paths:
schema:
type: object
properties:
- reason: &617
+ reason: &614
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *616
+ placeholder_id: *613
required:
- reason
- placeholder_id
@@ -92945,7 +92516,7 @@ paths:
schema:
type: object
properties:
- reason: *617
+ reason: *614
expire_at:
type:
- string
@@ -92992,8 +92563,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -93008,7 +92579,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &618
+ items: &615
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -93036,15 +92607,15 @@ paths:
the scan is pending
pattern_update_scans:
type: array
- items: *618
+ items: *615
backfill_scans:
type: array
- items: *618
+ items: *615
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *618
+ - *615
- type: object
properties:
pattern_name:
@@ -93114,8 +92685,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *50
- name: sort
description: The property to sort the results by.
@@ -93159,9 +92730,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *616
examples:
- default: *620
+ default: *617
'400': *14
'404': *6
x-github:
@@ -93184,8 +92755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -93355,9 +92926,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: &622
+ default: &619
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -93590,8 +93161,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -93704,7 +93275,7 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
default:
value:
@@ -93851,17 +93422,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'200':
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *622
+ default: *619
'403': *27
'404': *6
x-github:
@@ -93885,9 +93456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
requestBody:
required: true
content:
@@ -94058,10 +93629,10 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *622
- add_credit: *622
+ default: *619
+ add_credit: *619
'403': *27
'404': *6
'422':
@@ -94099,9 +93670,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:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'202': *37
'400': *14
@@ -94128,17 +93699,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *314
- - *315
- - *621
+ - *311
+ - *312
+ - *618
responses:
'202':
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
'400': *14
'422': *15
'403': *27
@@ -94164,8 +93735,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -94261,8 +93832,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -94271,7 +93842,7 @@ paths:
application/json:
schema:
type: array
- items: &623
+ items: &620
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -94304,8 +93875,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -94383,8 +93954,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -94478,8 +94049,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -94633,8 +94204,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -94644,7 +94215,7 @@ paths:
application/json:
schema:
type: array
- items: *623
+ items: *620
examples:
default:
value:
@@ -94677,8 +94248,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: sha
in: path
required: true
@@ -94734,7 +94305,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
default:
value:
@@ -94788,8 +94359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -94821,14 +94392,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &625
+ schema: &622
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -94901,8 +94472,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -94928,7 +94499,7 @@ paths:
description: Response
content:
application/json:
- schema: *625
+ schema: *622
examples:
default:
value:
@@ -94955,8 +94526,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -94976,8 +94547,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -95059,8 +94630,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95068,7 +94639,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
title: Tag protection
description: Tag protection
type: object
@@ -95125,8 +94696,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:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -95149,7 +94720,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -95180,8 +94751,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:
- - *314
- - *315
+ - *311
+ - *312
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -95218,8 +94789,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
in: path
required: true
@@ -95255,8 +94826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *17
- *19
responses:
@@ -95288,8 +94859,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *314
- - *315
+ - *311
+ - *312
- *19
- *17
responses:
@@ -95297,7 +94868,7 @@ paths:
description: Response
content:
application/json:
- schema: &627
+ schema: &624
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -95309,7 +94880,7 @@ paths:
required:
- names
examples:
- default: &628
+ default: &625
value:
names:
- octocat
@@ -95332,8 +94903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -95364,9 +94935,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
'404': *6
'422': *7
x-github:
@@ -95387,9 +94958,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *314
- - *315
- - &629
+ - *311
+ - *312
+ - &626
name: per
description: The time frame to display results for.
in: query
@@ -95420,7 +94991,7 @@ paths:
- 128
clones:
type: array
- items: &630
+ items: &627
title: Traffic
type: object
properties:
@@ -95508,8 +95079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95604,8 +95175,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'200':
description: Response
@@ -95669,9 +95240,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *314
- - *315
- - *629
+ - *311
+ - *312
+ - *626
responses:
'200':
description: Response
@@ -95692,7 +95263,7 @@ paths:
- 3782
views:
type: array
- items: *630
+ items: *627
required:
- uniques
- count
@@ -95770,8 +95341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
requestBody:
required: true
content:
@@ -96045,8 +95616,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -96069,8 +95640,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -96092,8 +95663,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -96119,8 +95690,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *314
- - *315
+ - *311
+ - *312
- name: ref
in: path
required: true
@@ -96212,9 +95783,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -96463,7 +96034,7 @@ paths:
examples:
- 73..77
- 77..78
- text_matches: &631
+ text_matches: &628
title: Search Result Text Matches
type: array
items:
@@ -96626,7 +96197,7 @@ paths:
enum:
- author-date
- committer-date
- - &632
+ - &629
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
@@ -96695,7 +96266,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
comment_count:
type: integer
message:
@@ -96714,7 +96285,7 @@ paths:
url:
type: string
format: uri
- verification: *495
+ verification: *492
required:
- author
- committer
@@ -96729,7 +96300,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *379
+ - *376
parents:
type: array
items:
@@ -96746,7 +96317,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *631
+ text_matches: *628
required:
- sha
- node_id
@@ -96938,7 +96509,7 @@ paths:
- interactions
- created
- updated
- - *632
+ - *629
- *17
- *19
- name: advanced_search
@@ -97035,11 +96606,11 @@ paths:
type:
- string
- 'null'
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
type: string
state_reason:
@@ -97067,7 +96638,7 @@ paths:
- string
- 'null'
format: date-time
- text_matches: *631
+ text_matches: *628
pull_request:
type: object
properties:
@@ -97290,7 +96861,7 @@ paths:
enum:
- created
- updated
- - *632
+ - *629
- *17
- *19
responses:
@@ -97335,7 +96906,7 @@ paths:
- 'null'
score:
type: number
- text_matches: *631
+ text_matches: *628
required:
- id
- node_id
@@ -97420,7 +96991,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *632
+ - *629
- *17
- *19
responses:
@@ -97657,7 +97228,7 @@ paths:
- admin
- pull
- push
- text_matches: *631
+ text_matches: *628
temp_clone_token:
type: string
allow_merge_commit:
@@ -97965,7 +97536,7 @@ paths:
- string
- 'null'
format: uri
- text_matches: *631
+ text_matches: *628
related:
type:
- array
@@ -98158,7 +97729,7 @@ paths:
- followers
- repositories
- joined
- - *632
+ - *629
- *17
- *19
responses:
@@ -98268,7 +97839,7 @@ paths:
type:
- boolean
- 'null'
- text_matches: *631
+ text_matches: *628
blog:
type:
- string
@@ -98350,7 +97921,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &636
+ - &633
name: team_id
description: The unique identifier of the team.
in: path
@@ -98391,7 +97962,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *636
+ - *633
requestBody:
required: true
content:
@@ -98492,7 +98063,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *636
+ - *633
responses:
'204':
description: Response
@@ -98523,7 +98094,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *636
+ - *633
- *50
- *17
- *19
@@ -98536,7 +98107,7 @@ paths:
type: array
items: *307
examples:
- default: *637
+ default: *634
headers:
Link: *56
x-github:
@@ -98565,7 +98136,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *636
+ - *633
requestBody:
required: true
content:
@@ -98628,7 +98199,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
responses:
'200':
@@ -98662,7 +98233,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
requestBody:
required: false
@@ -98688,7 +98259,7 @@ paths:
application/json:
schema: *307
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98713,7 +98284,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *636
+ - *633
- *309
responses:
'204':
@@ -98726,218 +98297,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:
- - *636
- - *309
- - *50
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *310
- examples:
- default: *639
- headers:
- Link: *56
- 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:
- - *636
- - *309
- 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: *310
- examples:
- default: *311
- 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:
- - *636
- - *309
- - *312
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *310
- examples:
- default: *311
- 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:
- - *636
- - *309
- - *312
- 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: *310
- examples:
- default: *640
- 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:
- - *636
- - *309
- - *312
- 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)
@@ -98953,7 +98312,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -98991,7 +98350,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *636
+ - *633
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -99042,7 +98401,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99079,7 +98438,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99119,7 +98478,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99156,16 +98515,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'200':
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-user-is-a-team-maintainer: *641
+ response-if-user-is-a-team-maintainer: *636
'404': *6
x-github:
githubCloudOnly: false
@@ -99198,7 +98557,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
requestBody:
required: false
@@ -99224,9 +98583,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- response-if-users-membership-with-team-is-now-pending: *642
+ response-if-users-membership-with-team-is-now-pending: *637
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -99260,7 +98619,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *636
+ - *633
- *61
responses:
'204':
@@ -99288,7 +98647,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -99330,15 +98689,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *643
+ schema: *638
examples:
alternative-response-with-extra-repository-information:
value:
@@ -99489,9 +98848,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
requestBody:
required: false
content:
@@ -99541,9 +98900,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *636
- - *314
- - *315
+ - *633
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -99568,7 +98927,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *636
+ - *633
- *17
- *19
responses:
@@ -99580,7 +98939,7 @@ paths:
type: array
items: *180
examples:
- response-if-child-teams-exist: *644
+ response-if-child-teams-exist: *639
headers:
Link: *56
'404': *6
@@ -99613,7 +98972,7 @@ paths:
application/json:
schema:
oneOf:
- - &646
+ - &641
title: Private User
description: Private User
type: object
@@ -99863,7 +99222,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *645
+ - *640
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -100023,7 +99382,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *641
examples:
default:
value:
@@ -100369,7 +99728,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -100377,7 +99736,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -100421,7 +99780,7 @@ paths:
type: integer
secrets:
type: array
- items: &647
+ items: &642
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -100463,7 +99822,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *436
+ default: *433
headers:
Link: *56
x-github:
@@ -100541,7 +99900,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *642
examples:
default:
value:
@@ -100687,7 +100046,7 @@ paths:
type: array
items: *144
examples:
- default: *648
+ default: *643
'401': *23
'403': *27
'404': *6
@@ -100839,7 +100198,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'304': *35
'500': *104
'401': *23
@@ -100897,7 +100256,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'401': *23
'403': *27
'404': *6
@@ -100954,7 +100313,7 @@ paths:
description: Response
content:
application/json:
- schema: &649
+ schema: &644
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -101007,7 +100366,7 @@ paths:
examples:
- https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &650
+ default: &645
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -101052,9 +100411,9 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *644
examples:
- default: *650
+ default: *645
'404': *6
x-github:
githubCloudOnly: false
@@ -101091,9 +100450,9 @@ paths:
type: integer
machines:
type: array
- items: *435
+ items: *432
examples:
- default: *651
+ default: *646
'304': *35
'500': *104
'401': *23
@@ -101178,11 +100537,11 @@ paths:
- 26a7c758-7299-4a73-b978-5a92a7ae98a0
owner: *4
billable_owner: *4
- repository: *317
+ repository: *314
machine:
anyOf:
- type: 'null'
- - *435
+ - *432
devcontainer_path:
description: Path to devcontainer.json from repo root used to
create Codespace.
@@ -101987,7 +101346,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'304': *35
'500': *104
'400': *14
@@ -102027,7 +101386,7 @@ paths:
application/json:
schema: *221
examples:
- default: *434
+ default: *431
'500': *104
'401': *23
'403': *27
@@ -102059,7 +101418,7 @@ paths:
type: array
items: *233
examples:
- default: &662
+ default: &657
value:
- id: 197
name: hello_docker
@@ -102160,7 +101519,7 @@ paths:
application/json:
schema:
type: array
- items: &652
+ items: &647
title: Email
description: Email
type: object
@@ -102230,9 +101589,9 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
- default: &664
+ default: &659
value:
- email: octocat@github.com
verified: true
@@ -102309,7 +101668,7 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
default:
value:
@@ -102567,7 +101926,7 @@ paths:
application/json:
schema:
type: array
- items: &653
+ items: &648
title: GPG Key
description: A unique encryption key
type: object
@@ -102712,7 +102071,7 @@ paths:
- subkeys
- revoked
examples:
- default: &678
+ default: &673
value:
- id: 3
name: Octocat's GPG Key
@@ -102797,9 +102156,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *648
examples:
- default: &654
+ default: &649
value:
id: 3
name: Octocat's GPG Key
@@ -102856,7 +102215,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &655
+ - &650
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -102868,9 +102227,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *648
examples:
- default: *654
+ default: *649
'404': *6
'304': *35
'403': *27
@@ -102893,7 +102252,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *655
+ - *650
responses:
'204':
description: Response
@@ -103198,7 +102557,7 @@ paths:
required: true
content:
application/json:
- schema: *506
+ schema: *503
examples:
default:
value:
@@ -103348,7 +102707,7 @@ paths:
application/json:
schema:
type: array
- items: &656
+ items: &651
title: Key
description: Key
type: object
@@ -103451,9 +102810,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *651
examples:
- default: &657
+ default: &652
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -103486,15 +102845,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *535
+ - *532
responses:
'200':
description: Response
content:
application/json:
- schema: *656
+ schema: *651
examples:
- default: *657
+ default: *652
'404': *6
'304': *35
'403': *27
@@ -103517,7 +102876,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *535
+ - *532
responses:
'204':
description: Response
@@ -103550,7 +102909,7 @@ paths:
application/json:
schema:
type: array
- items: &658
+ items: &653
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -103629,7 +102988,7 @@ paths:
- account
- plan
examples:
- default: &659
+ default: &654
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -103691,9 +103050,9 @@ paths:
application/json:
schema:
type: array
- items: *658
+ items: *653
examples:
- default: *659
+ default: *654
headers:
Link: *56
'304': *35
@@ -104711,7 +104070,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *228
- - *660
+ - *655
responses:
'204':
description: Response
@@ -104826,7 +104185,7 @@ paths:
- docker
- nuget
- container
- - *661
+ - *656
- *19
- *17
responses:
@@ -104838,8 +104197,8 @@ paths:
type: array
items: *233
examples:
- default: *662
- '400': *663
+ default: *657
+ '400': *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104868,7 +104227,7 @@ paths:
application/json:
schema: *233
examples:
- default: &679
+ default: &674
value:
id: 40201
name: octo-name
@@ -105230,9 +104589,9 @@ paths:
application/json:
schema:
type: array
- items: *652
+ items: *647
examples:
- default: *664
+ default: *659
headers:
Link: *56
'304': *35
@@ -105345,7 +104704,7 @@ paths:
type: array
items: *68
examples:
- default: &671
+ default: &666
summary: Default response
value:
- id: 1296269
@@ -105663,9 +105022,9 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
- default: *319
+ default: *316
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -105703,9 +105062,9 @@ paths:
application/json:
schema:
type: array
- items: *508
+ items: *505
examples:
- default: *665
+ default: *660
headers:
Link: *56
'304': *35
@@ -105784,7 +105143,7 @@ paths:
application/json:
schema:
type: array
- items: &666
+ items: &661
title: Social account
description: Social media account
type: object
@@ -105801,7 +105160,7 @@ paths:
- provider
- url
examples:
- default: &667
+ default: &662
value:
- provider: twitter
url: https://twitter.com/github
@@ -105864,9 +105223,9 @@ paths:
application/json:
schema:
type: array
- items: *666
+ items: *661
examples:
- default: *667
+ default: *662
'422': *15
'304': *35
'404': *6
@@ -105954,7 +105313,7 @@ paths:
application/json:
schema:
type: array
- items: &668
+ items: &663
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -105974,7 +105333,7 @@ paths:
- title
- created_at
examples:
- default: &697
+ default: &692
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -106039,9 +105398,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: &669
+ default: &664
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -106071,7 +105430,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:
- - &670
+ - &665
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -106083,9 +105442,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: *669
+ default: *664
'404': *6
'304': *35
'403': *27
@@ -106108,7 +105467,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:
- - *670
+ - *665
responses:
'204':
description: Response
@@ -106137,7 +105496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &698
+ - &693
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
@@ -106162,11 +105521,11 @@ paths:
type: array
items: *68
examples:
- default-response: *671
+ default-response: *666
application/vnd.github.v3.star+json:
schema:
type: array
- items: &699
+ items: &694
title: Starred Repository
description: Starred Repository
type: object
@@ -106322,8 +105681,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:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response if this repository is starred by you
@@ -106351,8 +105710,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -106376,8 +105735,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *314
- - *315
+ - *311
+ - *312
responses:
'204':
description: Response
@@ -106535,10 +105894,10 @@ paths:
application/json:
schema:
oneOf:
- - *646
- - *645
+ - *641
+ - *640
examples:
- default-response: &673
+ default-response: &668
summary: Default response
value:
login: octocat
@@ -106573,7 +105932,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &674
+ response-with-git-hub-plan-information: &669
summary: Response with GitHub plan information
value:
login: octocat
@@ -106695,7 +106054,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *672
+ - *667
- *17
responses:
'200':
@@ -106744,11 +106103,11 @@ paths:
application/json:
schema:
oneOf:
- - *646
- - *645
+ - *641
+ - *640
examples:
- default-response: *673
- response-with-git-hub-plan-information: *674
+ default-response: *668
+ response-with-git-hub-plan-information: *669
'404': *6
x-github:
githubCloudOnly: false
@@ -106798,8 +106157,8 @@ paths:
required:
- subject_digests
examples:
- default: *675
- withPredicateType: *676
+ default: *670
+ withPredicateType: *671
responses:
'200':
description: Response
@@ -106853,7 +106212,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *677
+ default: *672
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -107058,7 +106417,7 @@ paths:
initiator:
type: string
examples:
- default: *375
+ default: *372
'201':
description: Response
content:
@@ -107099,7 +106458,7 @@ paths:
type: array
items: *233
examples:
- default: *662
+ default: *657
'403': *27
'401': *23
x-github:
@@ -107483,9 +106842,9 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *648
examples:
- default: *678
+ default: *673
headers:
Link: *56
x-github:
@@ -107589,7 +106948,7 @@ paths:
application/json:
schema: *20
examples:
- default: *505
+ default: *502
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -107714,7 +107073,7 @@ paths:
- docker
- nuget
- container
- - *661
+ - *656
- *61
- *19
- *17
@@ -107727,10 +107086,10 @@ paths:
type: array
items: *233
examples:
- default: *662
+ default: *657
'403': *27
'401': *23
- '400': *663
+ '400': *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -107760,7 +107119,7 @@ paths:
application/json:
schema: *233
examples:
- default: *679
+ default: *674
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -108109,7 +107468,7 @@ paths:
type: array
items: *254
examples:
- default: *680
+ default: *675
headers:
Link: *56
'304': *35
@@ -108169,7 +107528,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *681
+ items: *676
required:
- name
- data_type
@@ -108185,7 +107544,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *682
+ iteration_configuration: *677
required:
- name
- data_type
@@ -108207,8 +107566,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *683
- iteration_field: *684
+ single_select_field: *678
+ iteration_field: *679
responses:
'201':
description: Response
@@ -108216,11 +107575,11 @@ paths:
application/json:
schema: *254
examples:
- text_field: *685
- number_field: *686
- date_field: *687
- single_select_field: *688
- iteration_field: *689
+ text_field: *680
+ number_field: *681
+ date_field: *682
+ single_select_field: *683
+ iteration_field: *684
'304': *35
'403': *27
'401': *23
@@ -108242,7 +107601,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *251
- - *690
+ - *685
- *61
responses:
'200':
@@ -108251,7 +107610,7 @@ paths:
application/json:
schema: *254
examples:
- default: *691
+ default: *686
headers:
Link: *56
'304': *35
@@ -108604,7 +107963,7 @@ paths:
parameters:
- *251
- *61
- - *692
+ - *687
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -108879,7 +108238,7 @@ paths:
- *107
- *109
- *108
- - *693
+ - *688
- *110
responses:
'200':
@@ -109010,7 +108369,7 @@ paths:
parameters:
- *61
- *107
- - *694
+ - *689
- *108
responses:
'200':
@@ -109109,9 +108468,9 @@ paths:
- *107
- *109
- *108
- - *695
+ - *690
- *110
- - *696
+ - *691
responses:
'200':
description: Response when getting a billing usage summary
@@ -109245,9 +108604,9 @@ paths:
application/json:
schema:
type: array
- items: *666
+ items: *661
examples:
- default: *667
+ default: *662
headers:
Link: *56
x-github:
@@ -109277,9 +108636,9 @@ paths:
application/json:
schema:
type: array
- items: *668
+ items: *663
examples:
- default: *697
+ default: *692
headers:
Link: *56
x-github:
@@ -109304,7 +108663,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *61
- - *698
+ - *693
- *50
- *17
- *19
@@ -109316,11 +108675,11 @@ paths:
schema:
anyOf:
- type: array
- items: *699
+ items: *694
- type: array
items: *68
examples:
- default-response: *671
+ default-response: *666
headers:
Link: *56
x-github:
@@ -109480,7 +108839,7 @@ webhooks:
type: string
enum:
- disabled
- enterprise: &700
+ enterprise: &695
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -109549,7 +108908,7 @@ webhooks:
- created_at
- updated_at
- avatar_url
- installation: &701
+ installation: &696
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -109570,7 +108929,7 @@ webhooks:
required:
- id
- node_id
- organization: &702
+ organization: &697
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -109643,7 +109002,7 @@ webhooks:
- public_members_url
- avatar_url
- description
- repository: &703
+ repository: &698
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
@@ -110556,10 +109915,10 @@ webhooks:
type: string
enum:
- enabled
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -110635,11 +109994,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: &704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: &699
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)
@@ -110862,11 +110221,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: *704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: *699
sender: *4
required:
- action
@@ -111054,11 +110413,11 @@ webhooks:
- everyone
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- rule: *704
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ rule: *699
sender: *4
required:
- action
@@ -111142,7 +110501,7 @@ webhooks:
type: string
enum:
- completed
- check_run: &706
+ check_run: &701
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -111252,7 +110611,7 @@ webhooks:
-
examples:
- neutral
- deployment: *705
+ deployment: *700
details_url:
type: string
examples:
@@ -111350,10 +110709,10 @@ webhooks:
- output
- app
- pull_requests
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -111746,11 +111105,11 @@ webhooks:
type: string
enum:
- created
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -112146,11 +111505,11 @@ webhooks:
type: string
enum:
- requested_action
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
requested_action:
description: The action requested by the user.
type: object
@@ -112555,11 +111914,11 @@ webhooks:
type: string
enum:
- rerequested
- check_run: *706
- installation: *701
- enterprise: *700
- organization: *702
- repository: *703
+ check_run: *701
+ installation: *696
+ enterprise: *695
+ organization: *697
+ repository: *698
sender: *4
required:
- check_run
@@ -113551,10 +112910,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -114263,10 +113622,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -114969,10 +114328,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -115141,7 +114500,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -115293,20 +114652,20 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &707
+ commit_oid: &702
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: *700
- installation: *701
- organization: *702
- ref: &708
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: &703
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: *703
+ repository: *698
sender: *4
required:
- action
@@ -115473,7 +114832,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -115714,12 +115073,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -115817,7 +115176,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116002,12 +115361,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -116176,7 +115535,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -116353,12 +115712,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -116459,7 +115818,7 @@ webhooks:
type:
- object
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116648,9 +116007,9 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
@@ -116658,7 +116017,7 @@ webhooks:
type:
- string
- 'null'
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -116757,7 +116116,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -116904,12 +116263,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *707
- enterprise: *700
- installation: *701
- organization: *702
- ref: *708
- repository: *703
+ commit_oid: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
+ ref: *703
+ repository: *698
sender: *4
required:
- action
@@ -117078,7 +116437,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *406
+ dismissed_comment: *403
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -117230,10 +116589,10 @@ webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -117493,10 +116852,10 @@ webhooks:
- updated_at
- author_association
- body
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -117577,18 +116936,18 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *702
- pusher_type: &709
+ organization: *697
+ pusher_type: &704
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &710
+ ref: &705
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -117598,7 +116957,7 @@ webhooks:
enum:
- tag
- branch
- repository: *703
+ repository: *698
sender: *4
required:
- ref
@@ -117681,9 +117040,9 @@ webhooks:
enum:
- created
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117768,9 +117127,9 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117848,9 +117207,9 @@ webhooks:
enum:
- promote_to_enterprise
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -117928,9 +117287,9 @@ webhooks:
enum:
- updated
definition: *261
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -118007,10 +117366,10 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- repository: *703
- organization: *702
+ enterprise: *695
+ installation: *696
+ repository: *698
+ organization: *697
sender: *4
new_property_values:
type: array
@@ -118095,18 +117454,18 @@ webhooks:
title: delete event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- pusher_type: *709
- ref: *710
+ enterprise: *695
+ installation: *696
+ organization: *697
+ pusher_type: *704
+ ref: *705
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *703
+ repository: *698
sender: *4
required:
- ref
@@ -118190,11 +117549,11 @@ webhooks:
type: string
enum:
- auto_dismissed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118278,11 +117637,11 @@ webhooks:
type: string
enum:
- auto_reopened
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118366,11 +117725,11 @@ webhooks:
type: string
enum:
- created
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118452,11 +117811,11 @@ webhooks:
type: string
enum:
- dismissed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118538,11 +117897,11 @@ webhooks:
type: string
enum:
- fixed
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118625,11 +117984,11 @@ webhooks:
type: string
enum:
- reintroduced
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118711,11 +118070,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *464
- installation: *701
- organization: *702
- enterprise: *700
- repository: *703
+ alert: *461
+ installation: *696
+ organization: *697
+ enterprise: *695
+ repository: *698
sender: *4
required:
- action
@@ -118792,9 +118151,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- key: &711
+ enterprise: *695
+ installation: *696
+ key: &706
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -118832,8 +118191,8 @@ webhooks:
- verified
- created_at
- read_only
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -118910,11 +118269,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- key: *711
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ key: *706
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -119486,12 +118845,12 @@ webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: &715
+ workflow: &710
title: Workflow
type:
- object
@@ -120229,13 +119588,13 @@ webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *470
+ deployment: *467
pull_requests:
type: array
- items: *555
- repository: *703
- organization: *702
- installation: *701
+ items: *552
+ repository: *698
+ organization: *697
+ installation: *696
sender: *4
responses:
'200':
@@ -120306,7 +119665,7 @@ webhooks:
type: string
enum:
- approved
- approver: &712
+ approver: &707
type: object
properties:
avatar_url:
@@ -120349,11 +119708,11 @@ webhooks:
type: string
comment:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- reviewers: &713
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ reviewers: &708
type: array
items:
type: object
@@ -120434,7 +119793,7 @@ webhooks:
sender: *4
since:
type: string
- workflow_job_run: &714
+ workflow_job_run: &709
type: object
properties:
conclusion:
@@ -121180,18 +120539,18 @@ webhooks:
type: string
enum:
- rejected
- approver: *712
+ approver: *707
comment:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- reviewers: *713
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ reviewers: *708
sender: *4
since:
type: string
- workflow_job_run: *714
+ workflow_job_run: *709
workflow_job_runs:
type: array
items:
@@ -121908,13 +121267,13 @@ webhooks:
type: string
enum:
- requested
- enterprise: *700
+ enterprise: *695
environment:
type: string
- installation: *701
- organization: *702
- repository: *703
- requestor: &720
+ installation: *696
+ organization: *697
+ repository: *698
+ requestor: &715
title: User
type:
- object
@@ -123857,12 +123216,12 @@ webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Deployment Workflow Run
type:
@@ -124553,7 +123912,7 @@ webhooks:
type: string
enum:
- answered
- answer: &718
+ answer: &713
type: object
properties:
author_association:
@@ -124713,11 +124072,11 @@ webhooks:
- created_at
- updated_at
- body
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -124844,11 +124203,11 @@ webhooks:
- from
required:
- category
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -124931,11 +124290,11 @@ webhooks:
type: string
enum:
- closed
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125017,7 +124376,7 @@ webhooks:
type: string
enum:
- created
- comment: &717
+ comment: &712
type: object
properties:
author_association:
@@ -125177,11 +124536,11 @@ webhooks:
- updated_at
- body
- reactions
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125264,12 +124623,12 @@ webhooks:
type: string
enum:
- deleted
- comment: *717
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ comment: *712
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125364,12 +124723,12 @@ webhooks:
- from
required:
- body
- comment: *717
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ comment: *712
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125453,11 +124812,11 @@ webhooks:
type: string
enum:
- created
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125539,11 +124898,11 @@ webhooks:
type: string
enum:
- deleted
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125643,11 +125002,11 @@ webhooks:
type: string
required:
- from
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125729,10 +125088,10 @@ webhooks:
type: string
enum:
- labeled
- discussion: *716
- enterprise: *700
- installation: *701
- label: &719
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ label: &714
title: Label
type: object
properties:
@@ -125765,8 +125124,8 @@ webhooks:
- color
- default
- description
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125849,11 +125208,11 @@ webhooks:
type: string
enum:
- locked
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -125935,11 +125294,11 @@ webhooks:
type: string
enum:
- pinned
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126021,11 +125380,11 @@ webhooks:
type: string
enum:
- reopened
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126110,16 +125469,16 @@ webhooks:
changes:
type: object
properties:
- new_discussion: *716
- new_repository: *703
+ new_discussion: *711
+ new_repository: *698
required:
- new_discussion
- new_repository
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126202,10 +125561,10 @@ webhooks:
type: string
enum:
- unanswered
- discussion: *716
- old_answer: *718
- organization: *702
- repository: *703
+ discussion: *711
+ old_answer: *713
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126287,12 +125646,12 @@ webhooks:
type: string
enum:
- unlabeled
- discussion: *716
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126375,11 +125734,11 @@ webhooks:
type: string
enum:
- unlocked
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126461,11 +125820,11 @@ webhooks:
type: string
enum:
- unpinned
- discussion: *716
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ discussion: *711
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -126538,7 +125897,7 @@ webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *700
+ enterprise: *695
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -127216,9 +126575,9 @@ webhooks:
type: integer
watchers_count:
type: integer
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- forkee
@@ -127364,9 +126723,9 @@ webhooks:
title: gollum event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pages:
description: The pages that were updated.
type: array
@@ -127404,7 +126763,7 @@ webhooks:
- action
- sha
- html_url
- repository: *703
+ repository: *698
sender: *4
required:
- pages
@@ -127480,10 +126839,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: &721
+ organization: *697
+ repositories: &716
description: An array of repository objects that the installation
can access.
type: array
@@ -127509,8 +126868,8 @@ webhooks:
- name
- full_name
- private
- repository: *703
- requester: *720
+ repository: *698
+ requester: *715
sender: *4
required:
- action
@@ -127585,11 +126944,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -127666,11 +127025,11 @@ webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -127747,10 +127106,10 @@ webhooks:
type: string
enum:
- added
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories_added: &722
+ organization: *697
+ repositories_added: &717
description: An array of repository objects, which were added to
the installation.
type: array
@@ -127796,15 +127155,15 @@ webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *703
- repository_selection: &723
+ repository: *698
+ repository_selection: &718
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *720
+ requester: *715
sender: *4
required:
- action
@@ -127883,10 +127242,10 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories_added: *722
+ organization: *697
+ repositories_added: *717
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -127913,9 +127272,9 @@ webhooks:
- name
- full_name
- private
- repository: *703
- repository_selection: *723
- requester: *720
+ repository: *698
+ repository_selection: *718
+ requester: *715
sender: *4
required:
- action
@@ -127994,11 +127353,11 @@ webhooks:
type: string
enum:
- suspend
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -128180,10 +127539,10 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
target_type:
type: string
@@ -128262,11 +127621,11 @@ webhooks:
type: string
enum:
- unsuspend
- enterprise: *700
+ enterprise: *695
installation: *20
- organization: *702
- repositories: *721
- repository: *703
+ organization: *697
+ repositories: *716
+ repository: *698
requester:
type:
- 'null'
@@ -128514,8 +127873,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -129332,8 +128691,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129694,8 +129053,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -129775,7 +129134,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &724
+ comment: &719
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -129942,8 +129301,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -130756,8 +130115,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131120,8 +130479,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -131201,7 +130560,7 @@ webhooks:
type: string
enum:
- edited
- changes: &748
+ changes: &743
description: The changes to the comment.
type: object
properties:
@@ -131213,9 +130572,9 @@ webhooks:
type: string
required:
- from
- comment: *724
- enterprise: *700
- installation: *701
+ comment: *719
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -132031,8 +131390,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132393,8 +131752,8 @@ webhooks:
- state
- locked
- assignee
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132484,9 +131843,9 @@ webhooks:
type: number
blocking_issue: *70
blocking_issue_repo: *68
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132575,9 +131934,9 @@ webhooks:
type: number
blocking_issue: *70
blocking_issue_repo: *68
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132665,9 +132024,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132756,9 +132115,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -132838,10 +132197,10 @@ webhooks:
type: string
enum:
- assigned
- assignee: *720
- enterprise: *700
- installation: *701
- issue: &727
+ assignee: *715
+ enterprise: *695
+ installation: *696
+ issue: &722
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -133653,11 +133012,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133777,8 +133136,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -133858,8 +133217,8 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -134676,11 +134035,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134943,8 +134302,8 @@ webhooks:
required:
- state
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -135023,8 +134382,8 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135832,11 +135191,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135955,8 +135314,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -136035,8 +135394,8 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136867,11 +136226,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136969,7 +136328,7 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: &725
+ milestone: &720
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -137112,8 +136471,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -137212,8 +136571,8 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -138025,11 +137384,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138149,9 +137508,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *719
- organization: *702
- repository: *703
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -138231,8 +137590,8 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -139043,11 +138402,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139167,9 +138526,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *719
- organization: *702
- repository: *703
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -139249,8 +138608,8 @@ webhooks:
type: string
enum:
- locked
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -140086,11 +139445,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140187,8 +139546,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -140267,8 +139626,8 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -141098,11 +140457,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141199,9 +140558,9 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: *725
- organization: *702
- repository: *703
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -142093,11 +141452,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -142674,8 +142033,8 @@ webhooks:
required:
- old_issue
- old_repository
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -143487,11 +142846,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143610,8 +142969,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -143691,9 +143050,9 @@ webhooks:
type: string
enum:
- pinned
- enterprise: *700
- installation: *701
- issue: &726
+ enterprise: *695
+ installation: *696
+ issue: &721
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -144499,11 +143858,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144622,8 +143981,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -144702,8 +144061,8 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -145537,11 +144896,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145639,8 +144998,8 @@ webhooks:
user_view_type:
type: string
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -146529,11 +145888,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147132,11 +146491,11 @@ webhooks:
required:
- new_issue
- new_repository
- enterprise: *700
- installation: *701
- issue: *726
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *721
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147216,12 +146575,12 @@ webhooks:
type: string
enum:
- typed
- enterprise: *700
- installation: *701
- issue: *727
+ enterprise: *695
+ installation: *696
+ issue: *722
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147302,7 +146661,7 @@ webhooks:
type: string
enum:
- unassigned
- assignee: &751
+ assignee: &746
title: User
type:
- object
@@ -147374,11 +146733,11 @@ webhooks:
required:
- login
- id
- enterprise: *700
- installation: *701
- issue: *727
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *722
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147457,12 +146816,12 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *700
- installation: *701
- issue: *727
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *722
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -147542,8 +146901,8 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -148377,11 +147736,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *633
- issue_dependencies_summary: *634
+ sub_issues_summary: *630
+ issue_dependencies_summary: *631
issue_field_values:
type: array
- items: *635
+ items: *632
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148478,8 +147837,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148559,11 +147918,11 @@ webhooks:
type: string
enum:
- unpinned
- enterprise: *700
- installation: *701
- issue: *726
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ issue: *721
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148642,12 +148001,12 @@ webhooks:
type: string
enum:
- untyped
- enterprise: *700
- installation: *701
- issue: *727
+ enterprise: *695
+ installation: *696
+ issue: *722
type: *216
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148727,11 +148086,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148809,11 +148168,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -148923,11 +148282,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- label: *719
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ label: *714
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -149009,9 +148368,9 @@ webhooks:
- cancelled
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: &728
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: &723
title: Marketplace Purchase
type: object
required:
@@ -149099,8 +148458,8 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *702
- previous_marketplace_purchase: &729
+ organization: *697
+ previous_marketplace_purchase: &724
title: Marketplace Purchase
type: object
properties:
@@ -149184,7 +148543,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149264,10 +148623,10 @@ webhooks:
- changed
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149355,7 +148714,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149437,10 +148796,10 @@ webhooks:
- pending_change
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149526,7 +148885,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -149607,8 +148966,8 @@ webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -149694,9 +149053,9 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *702
- previous_marketplace_purchase: *729
- repository: *703
+ organization: *697
+ previous_marketplace_purchase: *724
+ repository: *698
sender: *4
required:
- action
@@ -149776,12 +149135,12 @@ webhooks:
- purchased
effective_date:
type: string
- enterprise: *700
- installation: *701
- marketplace_purchase: *728
- organization: *702
- previous_marketplace_purchase: *729
- repository: *703
+ enterprise: *695
+ installation: *696
+ marketplace_purchase: *723
+ organization: *697
+ previous_marketplace_purchase: *724
+ repository: *698
sender: *4
required:
- action
@@ -149883,11 +149242,11 @@ webhooks:
type: string
required:
- to
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -149989,11 +149348,11 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150072,11 +149431,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150154,11 +149513,11 @@ webhooks:
type: string
enum:
- added
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -150236,7 +149595,7 @@ webhooks:
required:
- login
- id
- team: &730
+ team: &725
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -150466,11 +149825,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *700
- installation: *701
- member: *720
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ member: *715
+ organization: *697
+ repository: *698
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -150549,7 +149908,7 @@ webhooks:
required:
- login
- id
- team: *730
+ team: *725
required:
- action
- scope
@@ -150631,8 +149990,8 @@ webhooks:
type: string
enum:
- checks_requested
- installation: *701
- merge_group: &731
+ installation: *696
+ merge_group: &726
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -150651,15 +150010,15 @@ webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *395
+ head_commit: *392
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150745,10 +150104,10 @@ webhooks:
- merged
- invalidated
- dequeued
- installation: *701
- merge_group: *731
- organization: *702
- repository: *703
+ installation: *696
+ merge_group: *726
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -150821,7 +150180,7 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
+ enterprise: *695
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -150930,12 +150289,12 @@ webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -151015,11 +150374,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151098,9 +150457,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- milestone: &732
+ enterprise: *695
+ installation: *696
+ milestone: &727
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -151242,8 +150601,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151322,11 +150681,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151436,11 +150795,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- milestone: *725
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *720
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151520,11 +150879,11 @@ webhooks:
type: string
enum:
- opened
- enterprise: *700
- installation: *701
- milestone: *732
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ milestone: *727
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151603,11 +150962,11 @@ webhooks:
type: string
enum:
- blocked
- blocked_user: *720
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ blocked_user: *715
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151686,11 +151045,11 @@ webhooks:
type: string
enum:
- unblocked
- blocked_user: *720
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ blocked_user: *715
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151769,9 +151128,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- membership: &733
+ enterprise: *695
+ installation: *696
+ membership: &728
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -151881,8 +151240,8 @@ webhooks:
- role
- organization_url
- user
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -151960,11 +151319,11 @@ webhooks:
type: string
enum:
- member_added
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152043,8 +151402,8 @@ webhooks:
type: string
enum:
- member_invited
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -152166,10 +151525,10 @@ webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
- user: *720
+ user: *715
required:
- action
- invitation
@@ -152247,11 +151606,11 @@ webhooks:
type: string
enum:
- member_removed
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152338,11 +151697,11 @@ webhooks:
properties:
from:
type: string
- enterprise: *700
- installation: *701
- membership: *733
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ membership: *728
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -152418,9 +151777,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
package:
description: Information about the package.
type: object
@@ -152943,7 +152302,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: &734
+ items: &729
title: Ruby Gems metadata
type: object
properties:
@@ -153040,7 +152399,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -153116,9 +152475,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
package:
description: Information about the package.
type: object
@@ -153480,7 +152839,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *734
+ items: *729
source_url:
type: string
format: uri
@@ -153551,7 +152910,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -153732,12 +153091,12 @@ webhooks:
- duration
- created_at
- updated_at
- enterprise: *700
+ enterprise: *695
id:
type: integer
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- id
@@ -153814,7 +153173,7 @@ webhooks:
type: string
enum:
- approved
- personal_access_token_request: &735
+ personal_access_token_request: &730
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -153964,10 +153323,10 @@ webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *700
- organization: *702
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154044,11 +153403,11 @@ webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *735
- enterprise: *700
- organization: *702
+ personal_access_token_request: *730
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154124,11 +153483,11 @@ webhooks:
type: string
enum:
- created
- personal_access_token_request: *735
- enterprise: *700
- organization: *702
+ personal_access_token_request: *730
+ enterprise: *695
+ organization: *697
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154203,11 +153562,11 @@ webhooks:
type: string
enum:
- denied
- personal_access_token_request: *735
- organization: *702
- enterprise: *700
+ personal_access_token_request: *730
+ organization: *697
+ enterprise: *695
sender: *4
- installation: *701
+ installation: *696
required:
- action
- personal_access_token_request
@@ -154312,7 +153671,7 @@ webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *736
+ last_response: *731
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -154344,8 +153703,8 @@ webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
zen:
description: Random string of GitHub zen.
@@ -154590,10 +153949,10 @@ webhooks:
- from
required:
- note
- enterprise: *700
- installation: *701
- organization: *702
- project_card: &737
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: &732
title: Project Card
type: object
properties:
@@ -154716,7 +154075,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -154797,11 +154156,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project_card: *737
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: *732
+ repository: *698
sender: *4
required:
- action
@@ -154881,9 +154240,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
project_card:
title: Project Card
type: object
@@ -155013,7 +154372,7 @@ webhooks:
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -155107,11 +154466,11 @@ webhooks:
- from
required:
- note
- enterprise: *700
- installation: *701
- organization: *702
- project_card: *737
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_card: *732
+ repository: *698
sender: *4
required:
- action
@@ -155205,9 +154564,9 @@ webhooks:
- from
required:
- column_id
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
project_card:
allOf:
- title: Project Card
@@ -155404,7 +154763,7 @@ webhooks:
type: string
required:
- after_id
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155484,10 +154843,10 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- organization: *702
- project: &739
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: &734
title: Project
type: object
properties:
@@ -155614,7 +154973,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155694,10 +155053,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project_column: &738
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: &733
title: Project Column
type: object
properties:
@@ -155737,7 +155096,7 @@ webhooks:
- name
- created_at
- updated_at
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -155816,14 +155175,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -155912,11 +155271,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
+ repository: *698
sender: *4
required:
- action
@@ -155996,11 +155355,11 @@ webhooks:
type: string
enum:
- moved
- enterprise: *700
- installation: *701
- organization: *702
- project_column: *738
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project_column: *733
+ repository: *698
sender: *4
required:
- action
@@ -156080,11 +155439,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156164,14 +155523,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
repository:
anyOf:
- type: 'null'
- - *703
+ - *698
sender: *4
required:
- action
@@ -156272,11 +155631,11 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156355,11 +155714,11 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
- organization: *702
- project: *739
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ project: *734
+ repository: *698
sender: *4
required:
- action
@@ -156440,8 +155799,8 @@ webhooks:
type: string
enum:
- closed
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156523,8 +155882,8 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156606,8 +155965,8 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156729,8 +156088,8 @@ webhooks:
type: string
to:
type: string
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -156814,7 +156173,7 @@ webhooks:
type: string
enum:
- archived
- changes: &743
+ changes: &738
type: object
properties:
archived_at:
@@ -156830,9 +156189,9 @@ webhooks:
- string
- 'null'
format: date-time
- installation: *701
- organization: *702
- projects_v2_item: &740
+ installation: *696
+ organization: *697
+ projects_v2_item: &735
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -156972,9 +156331,9 @@ webhooks:
- 'null'
to:
type: string
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157056,9 +156415,9 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157139,9 +156498,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157246,7 +156605,7 @@ webhooks:
oneOf:
- type: string
- type: integer
- - &741
+ - &736
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -157270,7 +156629,7 @@ webhooks:
required:
- id
- name
- - &742
+ - &737
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -157310,8 +156669,8 @@ webhooks:
oneOf:
- type: string
- type: integer
- - *741
- - *742
+ - *736
+ - *737
type:
- 'null'
- string
@@ -157334,9 +156693,9 @@ webhooks:
- 'null'
required:
- body
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157433,9 +156792,9 @@ webhooks:
type:
- string
- 'null'
- installation: *701
- organization: *702
- projects_v2_item: *740
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157518,10 +156877,10 @@ webhooks:
type: string
enum:
- restored
- changes: *743
- installation: *701
- organization: *702
- projects_v2_item: *740
+ changes: *738
+ installation: *696
+ organization: *697
+ projects_v2_item: *735
sender: *4
required:
- action
@@ -157603,8 +156962,8 @@ webhooks:
type: string
enum:
- reopened
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
projects_v2: *249
sender: *4
required:
@@ -157686,9 +157045,9 @@ webhooks:
type: string
enum:
- created
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157769,9 +157128,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157917,9 +157276,9 @@ webhooks:
- string
- 'null'
format: date
- installation: *701
- organization: *702
- projects_v2_status_update: *744
+ installation: *696
+ organization: *697
+ projects_v2_status_update: *739
sender: *4
required:
- action
@@ -157990,10 +157349,10 @@ webhooks:
title: public event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- repository
@@ -158070,13 +157429,13 @@ webhooks:
type: string
enum:
- assigned
- assignee: *720
- enterprise: *700
- installation: *701
- number: &745
+ assignee: *715
+ enterprise: *695
+ installation: *696
+ number: &740
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -160425,7 +159784,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -160507,11 +159866,11 @@ webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -162853,7 +162212,7 @@ webhooks:
- draft
reason:
type: string
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -162935,11 +162294,11 @@ webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -165281,7 +164640,7 @@ webhooks:
- draft
reason:
type: string
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -165363,13 +164722,13 @@ webhooks:
type: string
enum:
- closed
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: &746
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: &741
allOf:
- - *555
+ - *552
- type: object
properties:
allow_auto_merge:
@@ -165431,7 +164790,7 @@ webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -165512,12 +164871,12 @@ webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -165597,11 +164956,11 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *700
+ enterprise: *695
milestone: *252
- number: *745
- organization: *702
- pull_request: &747
+ number: *740
+ organization: *697
+ pull_request: &742
title: Pull Request
type: object
properties:
@@ -167928,7 +167287,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -168007,11 +167366,11 @@ webhooks:
type: string
enum:
- dequeued
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -170357,7 +169716,7 @@ webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -170481,12 +169840,12 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -170566,11 +169925,11 @@ webhooks:
type: string
enum:
- enqueued
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -172901,7 +172260,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -172981,11 +172340,11 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *700
- installation: *701
- label: *719
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ label: *714
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -175333,7 +174692,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -175414,10 +174773,10 @@ webhooks:
type: string
enum:
- locked
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -177763,7 +177122,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -177843,12 +177202,12 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *700
+ enterprise: *695
milestone: *252
- number: *745
- organization: *702
- pull_request: *747
- repository: *703
+ number: *740
+ organization: *697
+ pull_request: *742
+ repository: *698
sender: *4
required:
- action
@@ -177927,12 +177286,12 @@ webhooks:
type: string
enum:
- opened
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178013,12 +177372,12 @@ webhooks:
type: string
enum:
- ready_for_review
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178098,12 +177457,12 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
- pull_request: *746
- repository: *703
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
+ pull_request: *741
+ repository: *698
sender: *4
required:
- action
@@ -178478,9 +177837,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -180710,7 +180069,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -180790,7 +180149,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &749
+ comment: &744
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -181083,9 +180442,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -183303,7 +182662,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -183383,11 +182742,11 @@ webhooks:
type: string
enum:
- edited
- changes: *748
- comment: *749
- enterprise: *700
- installation: *701
- organization: *702
+ changes: *743
+ comment: *744
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
type: object
properties:
@@ -185608,7 +184967,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -185689,9 +185048,9 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -187924,7 +187283,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
review:
description: The review that was affected.
type: object
@@ -188175,9 +187534,9 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -190291,8 +189650,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
- review: &750
+ repository: *698
+ review: &745
description: The review that was affected.
type: object
properties:
@@ -190530,12 +189889,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -192882,7 +192241,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_reviewer:
title: User
type:
@@ -192968,12 +192327,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -195327,7 +194686,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195522,12 +194881,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -197876,7 +197235,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_reviewer:
title: User
type:
@@ -197963,12 +197322,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *700
- installation: *701
+ enterprise: *695
+ installation: *696
number:
description: The pull request number.
type: integer
- organization: *702
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -200308,7 +199667,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -200492,9 +199851,9 @@ webhooks:
type: string
enum:
- submitted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -202730,8 +202089,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
- review: *750
+ repository: *698
+ review: *745
sender: *4
required:
- action
@@ -202811,9 +202170,9 @@ webhooks:
type: string
enum:
- resolved
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -204944,7 +204303,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
thread:
type: object
@@ -205341,9 +204700,9 @@ webhooks:
type: string
enum:
- unresolved
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
pull_request:
title: Simple Pull Request
type: object
@@ -207457,7 +206816,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *703
+ repository: *698
sender: *4
thread:
type: object
@@ -207856,10 +207215,10 @@ webhooks:
type: string
before:
type: string
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -210194,7 +209553,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -210276,11 +209635,11 @@ webhooks:
type: string
enum:
- unassigned
- assignee: *751
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ assignee: *746
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -212630,7 +211989,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -212709,11 +212068,11 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *700
- installation: *701
- label: *719
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ label: *714
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -215052,7 +214411,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -215133,10 +214492,10 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *700
- installation: *701
- number: *745
- organization: *702
+ enterprise: *695
+ installation: *696
+ number: *740
+ organization: *697
pull_request:
title: Pull Request
type: object
@@ -217465,7 +216824,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -217668,7 +217027,7 @@ webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *700
+ enterprise: *695
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -217763,8 +217122,8 @@ webhooks:
- url
- author
- committer
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -218352,9 +217711,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
registry_package:
type: object
properties:
@@ -218831,7 +218190,7 @@ webhooks:
type: string
rubygems_metadata:
type: array
- items: *734
+ items: *729
summary:
type: string
tag_name:
@@ -218887,7 +218246,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -218965,9 +218324,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
registry_package:
type: object
properties:
@@ -219279,7 +218638,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *734
+ items: *729
summary:
type: string
tag_name:
@@ -219329,7 +218688,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -219406,10 +218765,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- release: &752
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: &747
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -219740,7 +219099,7 @@ webhooks:
- updated_at
- zipball_url
- body
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -219817,11 +219176,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -219938,11 +219297,11 @@ webhooks:
type: boolean
required:
- to
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -220020,9 +219379,9 @@ webhooks:
type: string
enum:
- prereleased
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -220358,7 +219717,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -220434,10 +219793,10 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- release: &753
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: &748
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -220770,7 +220129,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *703
+ repository: *698
sender: *4
required:
- action
@@ -220846,11 +220205,11 @@ webhooks:
type: string
enum:
- released
- enterprise: *700
- installation: *701
- organization: *702
- release: *752
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *747
+ repository: *698
sender: *4
required:
- action
@@ -220926,11 +220285,11 @@ webhooks:
type: string
enum:
- unpublished
- enterprise: *700
- installation: *701
- organization: *702
- release: *753
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ release: *748
+ repository: *698
sender: *4
required:
- action
@@ -221006,11 +220365,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- repository_advisory: *619
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ repository_advisory: *616
sender: *4
required:
- action
@@ -221086,11 +220445,11 @@ webhooks:
type: string
enum:
- reported
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- repository_advisory: *619
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ repository_advisory: *616
sender: *4
required:
- action
@@ -221166,10 +220525,10 @@ webhooks:
type: string
enum:
- archived
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221246,10 +220605,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221327,10 +220686,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221415,10 +220774,10 @@ webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221533,10 +220892,10 @@ webhooks:
- 'null'
items:
type: string
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221608,10 +220967,10 @@ webhooks:
title: repository_import event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
status:
type: string
@@ -221692,10 +221051,10 @@ webhooks:
type: string
enum:
- privatized
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221772,10 +221131,10 @@ webhooks:
type: string
enum:
- publicized
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221869,10 +221228,10 @@ webhooks:
- name
required:
- repository
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -221952,10 +221311,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
sender: *4
required:
@@ -222034,10 +221393,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
sender: *4
required:
@@ -222116,10 +221475,10 @@ webhooks:
type: string
enum:
- edited
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
repository_ruleset: *292
changes:
type: object
@@ -222181,16 +221540,16 @@ webhooks:
properties:
added:
type: array
- items: *575
+ items: *572
deleted:
type: array
- items: *575
+ items: *572
updated:
type: array
items:
type: object
properties:
- rule: *575
+ rule: *572
changes:
type: object
properties:
@@ -222427,10 +221786,10 @@ webhooks:
- from
required:
- owner
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222508,10 +221867,10 @@ webhooks:
type: string
enum:
- unarchived
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222589,7 +221948,7 @@ webhooks:
type: string
enum:
- create
- alert: &754
+ alert: &749
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -222713,10 +222072,10 @@ webhooks:
type: string
enum:
- open
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -222926,10 +222285,10 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223007,11 +222366,11 @@ webhooks:
type: string
enum:
- reopen
- alert: *754
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *749
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223213,10 +222572,10 @@ webhooks:
enum:
- fixed
- open
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223294,7 +222653,7 @@ webhooks:
type: string
enum:
- assigned
- alert: &755
+ alert: &750
type: object
properties:
number: *162
@@ -223409,10 +222768,10 @@ webhooks:
- type: 'null'
- *4
assignee: *4
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223490,11 +222849,11 @@ webhooks:
type: string
enum:
- created
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223575,11 +222934,11 @@ webhooks:
type: string
enum:
- created
- alert: *755
- installation: *701
- location: *756
- organization: *702
- repository: *703
+ alert: *750
+ installation: *696
+ location: *751
+ organization: *697
+ repository: *698
sender: *4
required:
- location
@@ -223817,11 +223176,11 @@ webhooks:
type: string
enum:
- publicly_leaked
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223899,11 +223258,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -223981,11 +223340,11 @@ webhooks:
type: string
enum:
- resolved
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224063,12 +223422,12 @@ webhooks:
type: string
enum:
- unassigned
- alert: *755
+ alert: *750
assignee: *4
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224146,11 +223505,11 @@ webhooks:
type: string
enum:
- validated
- alert: *755
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ alert: *750
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -224280,10 +223639,10 @@ webhooks:
- organization
- enterprise
-
- repository: *703
- enterprise: *700
- installation: *701
- organization: *702
+ repository: *698
+ enterprise: *695
+ installation: *696
+ organization: *697
sender: *4
required:
- action
@@ -224361,11 +223720,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- security_advisory: &757
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ security_advisory: &752
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -224551,11 +223910,11 @@ webhooks:
type: string
enum:
- updated
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
- security_advisory: *757
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
+ security_advisory: *752
sender: *4
required:
- action
@@ -224628,10 +223987,10 @@ webhooks:
type: string
enum:
- withdrawn
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -224818,10 +224177,10 @@ webhooks:
type: object
properties:
security_and_analysis: *265
- enterprise: *700
- installation: *701
- organization: *702
- repository: *317
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *314
sender: *4
required:
- changes
@@ -224899,12 +224258,12 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: &758
+ sponsorship: &753
type: object
properties:
created_at:
@@ -225209,12 +224568,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- sponsorship
@@ -225302,12 +224661,12 @@ webhooks:
type: string
required:
- from
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225384,17 +224743,17 @@ webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &759
+ effective_date: &754
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: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- sponsorship
@@ -225468,7 +224827,7 @@ webhooks:
type: string
enum:
- pending_tier_change
- changes: &760
+ changes: &755
type: object
properties:
tier:
@@ -225512,13 +224871,13 @@ webhooks:
- from
required:
- tier
- effective_date: *759
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ effective_date: *754
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225595,13 +224954,13 @@ webhooks:
type: string
enum:
- tier_changed
- changes: *760
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ changes: *755
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- sponsorship: *758
+ sponsorship: *753
required:
- action
- changes
@@ -225675,10 +225034,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -225762,10 +225121,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -226199,15 +225558,15 @@ webhooks:
type:
- string
- 'null'
- enterprise: *700
+ enterprise: *695
id:
description: The unique identifier of the status.
type: integer
- installation: *701
+ installation: *696
name:
type: string
- organization: *702
- repository: *703
+ organization: *697
+ repository: *698
sender: *4
sha:
description: The Commit SHA.
@@ -226323,9 +225682,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226415,9 +225774,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226507,9 +225866,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226599,9 +225958,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *70
- installation: *701
- organization: *702
- repository: *703
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -226678,12 +226037,12 @@ webhooks:
title: team_add event
type: object
properties:
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- team: &761
+ team: &756
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -226913,9 +226272,9 @@ webhooks:
type: string
enum:
- added_to_repository
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -227385,7 +226744,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -227461,9 +226820,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -227933,7 +227292,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -228010,9 +227369,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -228482,7 +227841,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -228626,9 +227985,9 @@ webhooks:
- from
required:
- permissions
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -229098,7 +228457,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- changes
@@ -229176,9 +228535,9 @@ webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *700
- installation: *701
- organization: *702
+ enterprise: *695
+ installation: *696
+ organization: *697
repository:
title: Repository
description: A git repository
@@ -229648,7 +229007,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *761
+ team: *756
required:
- action
- team
@@ -229724,10 +229083,10 @@ webhooks:
type: string
enum:
- started
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
required:
- action
@@ -229800,17 +229159,17 @@ webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *700
+ enterprise: *695
inputs:
type:
- object
- 'null'
additionalProperties: true
- installation: *701
- organization: *702
+ installation: *696
+ organization: *697
ref:
type: string
- repository: *703
+ repository: *698
sender: *4
workflow:
type: string
@@ -229892,10 +229251,10 @@ webhooks:
type: string
enum:
- completed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
allOf:
@@ -230151,7 +229510,7 @@ webhooks:
type: string
required:
- conclusion
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230230,10 +229589,10 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
allOf:
@@ -230515,7 +229874,7 @@ webhooks:
required:
- status
- steps
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230594,10 +229953,10 @@ webhooks:
type: string
enum:
- queued
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
type: object
@@ -230743,7 +230102,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -230822,10 +230181,10 @@ webhooks:
type: string
enum:
- waiting
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
workflow_job:
type: object
@@ -230972,7 +230331,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *470
+ deployment: *467
required:
- action
- repository
@@ -231052,12 +230411,12 @@ webhooks:
type: string
enum:
- completed
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
@@ -232076,12 +231435,12 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
@@ -233085,12 +232444,12 @@ webhooks:
type: string
enum:
- requested
- enterprise: *700
- installation: *701
- organization: *702
- repository: *703
+ enterprise: *695
+ installation: *696
+ organization: *697
+ repository: *698
sender: *4
- workflow: *715
+ workflow: *710
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json
index 80d080638..47bb3ad4d 100644
--- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json
+++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json
@@ -285322,19 +285322,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -285466,8 +285453,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -285509,8 +285494,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",
@@ -285830,19 +285813,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -285974,8 +285944,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286015,8 +285983,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",
@@ -286302,19 +286268,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -286446,8 +286399,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286487,8 +286438,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",
@@ -286798,19 +286747,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -286942,8 +286878,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286983,8 +286917,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",
@@ -287075,17 +287007,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": [
{
@@ -287105,28 +287037,406 @@
"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",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "type": "string",
+ "examples": [
+ "2019-06-03 22:27:15:000 -700"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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",
+ "examples": [
+ 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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "type": "string",
+ "examples": [
+ "2021-01-03 22:27:15:000 -700"
+ ]
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "type": "string",
+ "examples": [
+ "team-test"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ]
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "type": "string",
+ "examples": [
+ "mona-lisa_eocsaxrs"
+ ]
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "type": "string",
+ "examples": [
+ "Mona Lisa"
+ ]
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "type": "string",
+ "examples": [
+ "mona_lisa@github.com"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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"
}
},
{
@@ -287156,322 +287466,543 @@
"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": {
- "anyOf": [
- {
- "type": "null"
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "failed_reason": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "inviter": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
},
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
]
},
- "body": {
- "description": "The main text of the comment.",
+ "team_count": {
+ "type": "integer"
+ },
+ "node_id": {
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
]
},
- "body_html": {
+ "invitation_teams_url": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "\"https://api.github.com/organizations/16/invitations/1/teams\""
]
},
- "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.",
+ "invitation_source": {
"type": "string",
"examples": [
- "0307116bbf7ced493b8d8a346c650b71"
+ "\"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": {
+ "type": [
+ "string",
+ "null"
]
},
- "created_at": {
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "octocat"
]
},
- "last_edited_at": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
"type": [
"string",
"null"
],
- "format": "date-time"
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "https://api.github.com/users/octocat"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/octocat"
]
},
- "node_id": {
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "https://api.github.com/users/octocat/followers"
]
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
+ "following_url": {
+ "type": "string",
"examples": [
- 42
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
]
},
- "url": {
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "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",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
},
"required": [
- "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"
]
}
@@ -287480,49 +288011,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
}
]
}
@@ -287543,19 +288049,126 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "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",
+ "type": "string",
+ "examples": [
+ "member"
+ ]
+ },
+ "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"
}
},
- "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.",
+ "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/create-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#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -287577,35 +288190,38 @@
}
},
{
- "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"
}
}
],
"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"
}
}
}
@@ -287613,403 +288229,83 @@
}
},
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
+ "url": {
"type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "format": "uri"
},
- "last_edited_at": {
- "type": [
- "string",
- "null"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
+ "default": "member",
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "member"
]
},
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- }
- },
- "/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.",
+ },
+ "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/get-discussion-comment-in-org",
+ "operationId": "teams/remove-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#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -288031,419 +288327,42 @@
}
},
{
- "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"
}
}
],
"responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
- }
- }
- }
- }
- }
- }
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"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.",
+ }
+ },
+ "/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/update-discussion-comment-in-org",
+ "operationId": "teams/list-repos-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/teams#list-team-repositories"
},
"parameters": [
{
@@ -288465,995 +288384,62 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "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"
+ "type": "integer",
+ "default": 30
}
},
{
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
+ "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"
+ "type": "integer",
+ "default": 1
}
}
],
- "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": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1296269
+ ]
},
- "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": {
- "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
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
},
- "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/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"
- }
- },
- {
- "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}/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",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "group_name": {
- "description": "The display name of the group",
- "type": "string",
- "examples": [
- "group-azuread-test"
- ]
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "type": "string",
- "examples": [
- "2019-06-03 22:27:15:000 -700"
- ]
- }
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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": "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",
- "examples": [
- 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",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "group_name": {
- "description": "The display name for the group",
- "type": "string",
- "examples": [
- "group-azuread-test"
- ]
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "type": "string",
- "examples": [
- "2021-01-03 22:27:15:000 -700"
- ]
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "team_name": {
- "description": "The name of the team",
- "type": "string",
- "examples": [
- "team-test"
- ]
- }
- }
- },
- "examples": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ]
- },
- "members": {
- "description": "An array of external members linked to this group",
- "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",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "member_login": {
- "description": "The handle/login for the user",
- "type": "string",
- "examples": [
- "mona-lisa_eocsaxrs"
- ]
- },
- "member_name": {
- "description": "The user display name/profile name",
- "type": "string",
- "examples": [
- "Mona Lisa"
- ]
- },
- "member_email": {
- "description": "An email attached to a user",
- "type": "string",
- "examples": [
- "mona_lisa@github.com"
- ]
- }
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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.",
- "in": "path",
- "required": true,
- "schema": {
- "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"
- }
- },
- {
- "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": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": [
- "string",
- "null"
+ "name": {
+ "type": "string",
+ "examples": [
+ "Hello-World"
]
},
- "failed_reason": {
- "type": [
- "string",
- "null"
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
]
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -289621,1196 +288607,261 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "https://github.com/octocat/Hello-World"
]
},
- "invitation_teams_url": {
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "https://api.github.com/repos/octocat/Hello-World"
]
},
- "invitation_source": {
+ "archive_url": {
"type": "string",
"examples": [
- "\"member\""
+ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
]
- }
- },
- "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": {
- "type": [
- "string",
- "null"
+ },
+ "assignees_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
]
},
- "email": {
- "type": [
- "string",
- "null"
+ "blobs_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
]
},
- "login": {
+ "branches_url": {
"type": "string",
"examples": [
- "octocat"
+ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
]
},
- "id": {
- "type": "integer",
- "format": "int64",
+ "collaborators_url": {
+ "type": "string",
"examples": [
- 1
+ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
]
},
- "node_id": {
+ "comments_url": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
+ "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
]
},
- "avatar_url": {
+ "commits_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ ]
+ },
+ "compare_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ ]
+ },
+ "contents_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ ]
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/images/error/octocat_happy.gif"
+ "http://api.github.com/repos/octocat/Hello-World/contributors"
]
},
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
"examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "http://api.github.com/repos/octocat/Hello-World/deployments"
]
},
- "url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/downloads"
]
},
- "html_url": {
+ "events_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/events"
]
},
- "followers_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "http://api.github.com/repos/octocat/Hello-World/forks"
]
},
- "following_url": {
+ "git_commits_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
]
},
- "gists_url": {
+ "git_refs_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
]
},
- "starred_url": {
+ "git_tags_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
]
},
- "subscriptions_url": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ ]
+ },
+ "issue_events_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ ]
+ },
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ ]
+ },
+ "keys_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ ]
+ },
+ "labels_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ ]
+ },
+ "languages_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "http://api.github.com/repos/octocat/Hello-World/languages"
]
},
- "organizations_url": {
+ "merges_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "http://api.github.com/repos/octocat/Hello-World/merges"
]
},
- "repos_url": {
+ "milestones_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ ]
+ },
+ "notifications_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ ]
+ },
+ "pulls_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "http://api.github.com/repos/octocat/Hello-World/stargazers"
]
},
- "events_url": {
+ "statuses_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
]
},
- "received_events_url": {
+ "subscribers_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "http://api.github.com/repos/octocat/Hello-World/subscribers"
]
},
- "type": {
+ "subscription_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "User"
+ "http://api.github.com/repos/octocat/Hello-World/subscription"
]
},
- "site_admin": {
- "type": "boolean"
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/tags"
+ ]
},
- "starred_at": {
+ "teams_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ "http://api.github.com/repos/octocat/Hello-World/teams"
]
},
- "user_view_type": {
+ "trees_url": {
"type": "string",
"examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "examples": [
- 1296269
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Hello-World"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "This your first repo!"
- ]
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/repos/octocat/Hello-World"
- ]
- },
- "archive_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- ]
- },
- "assignees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- ]
- },
- "blobs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- ]
- },
- "branches_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- ]
- },
- "collaborators_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- ]
- },
- "comments_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- ]
- },
- "commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- ]
- },
- "compare_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- ]
- },
- "contents_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- ]
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contributors"
- ]
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/deployments"
- ]
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/downloads"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/events"
- ]
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/forks"
- ]
- },
- "git_commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- ]
- },
- "git_refs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- ]
- },
- "git_tags_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- ]
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- ]
- },
- "issue_events_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- ]
- },
- "keys_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- ]
- },
- "labels_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- ]
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/languages"
- ]
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/merges"
- ]
- },
- "milestones_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- ]
- },
- "notifications_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- ]
- },
- "pulls_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- ]
- },
- "releases_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- ]
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
- ]
- },
- "statuses_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- ]
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
- ]
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscription"
- ]
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/tags"
- ]
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/teams"
- ]
- },
- "trees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
]
},
"clone_url": {
@@ -696060,3011 +694111,331 @@
"schema": {
"type": "string",
"enum": [
- "followers",
- "repositories",
- "joined"
- ]
- }
- },
- {
- "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 is ignored unless you provide `sort`.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "desc",
- "asc"
- ],
- "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": "object",
- "required": [
- "total_count",
- "incomplete_results",
- "items"
- ],
- "properties": {
- "total_count": {
- "type": "integer"
- },
- "incomplete_results": {
- "type": "boolean"
- },
- "items": {
- "type": "array",
- "items": {
- "title": "User Search Result Item",
- "description": "User Search Result Item",
- "type": "object",
- "properties": {
- "login": {
- "type": "string"
- },
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "node_id": {
- "type": "string"
- },
- "avatar_url": {
- "type": "string",
- "format": "uri"
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- },
- "followers_url": {
- "type": "string",
- "format": "uri"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri"
- },
- "repos_url": {
- "type": "string",
- "format": "uri"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri"
- },
- "type": {
- "type": "string"
- },
- "score": {
- "type": "number"
- },
- "following_url": {
- "type": "string"
- },
- "gists_url": {
- "type": "string"
- },
- "starred_url": {
- "type": "string"
- },
- "events_url": {
- "type": "string"
- },
- "public_repos": {
- "type": "integer"
- },
- "public_gists": {
- "type": "integer"
- },
- "followers": {
- "type": "integer"
- },
- "following": {
- "type": "integer"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "bio": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email"
- },
- "location": {
- "type": [
- "string",
- "null"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "hireable": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "type": [
- "string",
- "null"
- ]
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "blog": {
- "type": [
- "string",
- "null"
- ]
- },
- "company": {
- "type": [
- "string",
- "null"
- ]
- },
- "suspended_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "user_view_type": {
- "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",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 12,
- "incomplete_results": false,
- "items": [
- {
- "login": "mojombo",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
- "gravatar_id": "",
- "url": "https://api.github.com/users/mojombo",
- "html_url": "https://github.com/mojombo",
- "followers_url": "https://api.github.com/users/mojombo/followers",
- "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
- "organizations_url": "https://api.github.com/users/mojombo/orgs",
- "repos_url": "https://api.github.com/users/mojombo/repos",
- "received_events_url": "https://api.github.com/users/mojombo/received_events",
- "type": "User",
- "score": 1,
- "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
- "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
- "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
- "site_admin": true
- }
- ]
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "503": {
- "description": "Service unavailable",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/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-cloud@latest//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-cloud@latest//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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
- }
- },
- "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-cloud@latest//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-cloud@latest//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",
- "null"
- ],
- "description": "The ID of a team to set as the parent team."
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
+ "followers",
+ "repositories",
+ "joined"
+ ]
}
},
- "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"
- }
- }
- }
- }
+ {
+ "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 is ignored unless you provide `sort`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "desc",
+ "asc"
+ ],
+ "default": "desc"
}
},
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
+ {
+ "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": {
- "title": "Validation Error",
- "description": "Validation Error",
"type": "object",
"required": [
- "message",
- "documentation_url"
+ "total_count",
+ "incomplete_results",
+ "items"
],
"properties": {
- "message": {
- "type": "string"
+ "total_count": {
+ "type": "integer"
},
- "documentation_url": {
- "type": "string"
+ "incomplete_results": {
+ "type": "boolean"
},
- "errors": {
+ "items": {
"type": "array",
"items": {
+ "title": "User Search Result Item",
+ "description": "User Search Result Item",
"type": "object",
- "required": [
- "code"
- ],
"properties": {
- "resource": {
+ "login": {
"type": "string"
},
- "field": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
"type": "string"
},
- "message": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
"type": "string"
},
- "code": {
+ "score": {
+ "type": "number"
+ },
+ "following_url": {
"type": "string"
},
- "index": {
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "public_repos": {
"type": "integer"
},
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "bio": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email"
+ },
+ "location": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "hireable": {
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
"type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
}
}
+ }
+ },
+ "blog": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "company": {
+ "type": [
+ "string",
+ "null"
]
+ },
+ "suspended_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
+ },
+ "user_view_type": {
+ "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",
+ "score"
+ ]
}
}
}
- }
- }
- }
- },
- "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"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 12,
+ "incomplete_results": false,
+ "items": [
+ {
+ "login": "mojombo",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/mojombo",
+ "html_url": "https://github.com/mojombo",
+ "followers_url": "https://api.github.com/users/mojombo/followers",
+ "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
+ "organizations_url": "https://api.github.com/users/mojombo/orgs",
+ "repos_url": "https://api.github.com/users/mojombo/repos",
+ "received_events_url": "https://api.github.com/users/mojombo/received_events",
+ "type": "User",
+ "score": 1,
+ "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
+ "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
+ "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
+ "site_admin": true
+ }
+ ]
}
}
}
}
}
- }
- },
- "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-cloud@latest//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-cloud@latest//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",
+ "304": {
+ "description": "Not modified"
+ },
+ "503": {
+ "description": "Service unavailable",
"content": {
"application/json": {
"schema": {
- "title": "Basic Error",
- "description": "Basic Error",
"type": "object",
"properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
+ "code": {
"type": "string"
},
- "url": {
+ "message": {
"type": "string"
},
- "status": {
+ "documentation_url": {
"type": "string"
}
}
@@ -699151,25 +694522,22 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
+ "category": "search",
+ "subcategory": "search"
+ }
}
},
- "/teams/{team_id}/discussions": {
+ "/teams/{team_id}": {
"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-cloud@latest//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.",
+ "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-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-legacy",
+ "operationId": "teams/get-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
},
"parameters": [
{
@@ -699180,38 +694548,6 @@
"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": {
@@ -699220,545 +694556,115 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -699766,403 +694672,684 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
+ "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"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"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.",
+ },
+ "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-cloud@latest//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/get-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -700173,58 +695360,189 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "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",
+ "null"
+ ],
+ "description": "The ID of a team to set as the parent team."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Response",
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -700232,489 +695550,751 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
+ "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/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": {
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -700722,378 +696302,763 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "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": {
@@ -701102,20 +697067,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-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.",
+ "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-cloud@latest//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-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -701126,20 +697091,112 @@
"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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -701148,22 +697205,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-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.",
+ "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-cloud@latest//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-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -701175,15 +697232,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.",
@@ -701225,8 +697273,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": {
@@ -701405,16 +697453,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -701428,7 +697476,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -701438,45 +697486,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -701536,10 +697605,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -701569,19 +697641,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,
@@ -701614,20 +697689,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": [
{
@@ -701638,15 +697713,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -701656,19 +697722,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."
}
}
}
@@ -701681,8 +697758,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": {
@@ -701861,16 +697938,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -701884,7 +697961,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -701894,45 +697971,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -701992,10 +698090,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702023,19 +698124,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,
@@ -702060,22 +698164,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": [
{
@@ -702095,15 +698199,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -702112,8 +698207,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": {
@@ -702292,16 +698387,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -702315,7 +698410,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -702325,45 +698420,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -702423,10 +698539,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702454,19 +698573,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,
@@ -702490,20 +698612,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": [
{
@@ -702523,37 +698645,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"
}
}
}
@@ -702566,8 +698680,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": {
@@ -702746,16 +698860,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -702769,7 +698883,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -702779,45 +698893,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -702877,10 +699012,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702908,19 +699046,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,
@@ -702944,20 +699085,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": [
{
@@ -702977,15 +699118,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -702999,7 +699131,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml
index 263898764..adf6872a3 100644
--- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml
+++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml
@@ -1079,7 +1079,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:
- - &732
+ - &729
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1808,7 +1808,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &742
+ schema: &739
title: Scim Error
description: Scim Error
type: object
@@ -9260,7 +9260,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &743
+ '401': &740
description: Authorization failure
'404': *6
x-github:
@@ -13533,7 +13533,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &517
+ instances_url: &514
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13569,7 +13569,7 @@ paths:
format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissed_reason: &518
+ dismissed_reason: &515
type:
- string
- 'null'
@@ -13580,14 +13580,14 @@ paths:
- won't fix
- used in tests
-
- dismissed_comment: &519
+ dismissed_comment: &516
type:
- string
- 'null'
description: The dismissal comment associated with the dismissal
of the alert.
maxLength: 280
- rule: &520
+ rule: &517
type: object
properties:
id:
@@ -13648,7 +13648,7 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: &521
+ tool: &518
type: object
properties:
name: *109
@@ -13659,26 +13659,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *110
- most_recent_instance: &522
+ most_recent_instance: &519
type: object
properties:
- ref: &515
+ ref: &512
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &532
+ analysis_key: &529
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: &533
+ environment: &530
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: &534
+ category: &531
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13692,7 +13692,7 @@ paths:
properties:
text:
type: string
- location: &535
+ location: &532
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13713,7 +13713,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: &536
+ items: &533
type:
- string
- 'null'
@@ -17487,7 +17487,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
- - &573
+ - &570
name: has
in: query
description: |-
@@ -17604,7 +17604,7 @@ paths:
- direct
- transitive
-
- security_advisory: &574
+ security_advisory: &571
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17840,7 +17840,7 @@ paths:
dismissal.
maxLength: 280
fixed_at: *133
- auto_dismissed_at: &575
+ auto_dismissed_at: &572
type:
- string
- 'null'
@@ -17848,7 +17848,7 @@ paths:
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissal_request: &576
+ dismissal_request: &573
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -21392,7 +21392,7 @@ paths:
- object
rules:
type: array
- items: &698
+ items: &695
title: Repository Rule
type: object
description: A repository rule.
@@ -21401,7 +21401,7 @@ paths:
- *164
- *165
- *166
- - &696
+ - &693
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21961,14 +21961,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &710
+ state: &707
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: &711
+ resolution: &708
type:
- string
- 'null'
@@ -22075,14 +22075,14 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - &712
+ - &709
description: 'Details on the location where the token was
initially detected. This can be a commit, wiki commit, issue,
discussion, pull request.
'
oneOf:
- - &714
+ - &711
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -22139,7 +22139,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &715
+ - &712
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.
@@ -22200,7 +22200,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &716
+ - &713
description: Represents an 'issue_title' secret scanning
location type. This location type shows that a secret
was detected in the title of an issue.
@@ -22215,7 +22215,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &717
+ - &714
description: Represents an 'issue_body' secret scanning
location type. This location type shows that a secret
was detected in the body of an issue.
@@ -22230,7 +22230,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &718
+ - &715
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on an issue.
@@ -22245,7 +22245,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &719
+ - &716
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret
was detected in the title of a discussion.
@@ -22260,7 +22260,7 @@ paths:
- https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &720
+ - &717
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret
was detected in the body of a discussion.
@@ -22275,7 +22275,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &721
+ - &718
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on a discussion.
@@ -22290,7 +22290,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &722
+ - &719
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.
@@ -22305,7 +22305,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &723
+ - &720
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.
@@ -22320,7 +22320,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &724
+ - &721
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.
@@ -22335,7 +22335,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &725
+ - &722
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.
@@ -22350,7 +22350,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &726
+ - &723
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
@@ -25692,7 +25692,7 @@ paths:
properties:
action:
type: string
- discussion: &851
+ discussion: &846
title: Discussion
description: A Discussion in a repository.
type: object
@@ -26478,7 +26478,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &770
+ sub_issues_summary: &767
title: Sub-issues Summary
type: object
properties:
@@ -26499,7 +26499,7 @@ paths:
- string
- 'null'
format: uri
- issue_dependencies_summary: &771
+ issue_dependencies_summary: &768
title: Issue Dependencies Summary
type: object
properties:
@@ -26518,7 +26518,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &772
+ items: &769
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -26631,7 +26631,7 @@ paths:
action:
type: string
issue: *212
- comment: &633
+ comment: &630
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -27354,7 +27354,7 @@ paths:
type: string
release:
allOf:
- - &689
+ - &686
title: Release
description: A release.
type: object
@@ -27436,7 +27436,7 @@ paths:
author: *4
assets:
type: array
- items: &690
+ items: &687
title: Release Asset
description: Data related to a release.
type: object
@@ -28027,7 +28027,7 @@ paths:
url:
type: string
format: uri
- user: &782
+ user: &777
title: Public User
description: Public User
type: object
@@ -31384,14 +31384,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:
- - &444
+ - &441
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &445
+ - &442
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -31453,7 +31453,7 @@ paths:
'404': *6
'403': *27
'304': *35
- '301': &450
+ '301': &447
description: Moved permanently
content:
application/json:
@@ -31475,7 +31475,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &663
+ - &660
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -31483,7 +31483,7 @@ paths:
schema:
type: boolean
default: false
- - &664
+ - &661
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -31493,7 +31493,7 @@ paths:
type: boolean
default: false
- *218
- - &665
+ - &662
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:
@@ -32037,7 +32037,7 @@ paths:
- url
- subscription_url
examples:
- default: &666
+ default: &663
value:
- id: '1'
repository:
@@ -33166,7 +33166,7 @@ paths:
type: array
items: *149
examples:
- default: &672
+ default: &669
value:
- property_name: environment
value: production
@@ -33216,7 +33216,7 @@ paths:
required:
- properties
examples:
- default: &673
+ default: &670
value:
properties:
- property_name: environment
@@ -34107,7 +34107,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &457
+ items: &454
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -36230,7 +36230,7 @@ paths:
type: array
items: *272
examples:
- default: &785
+ default: &780
value:
total_count: 1
repositories:
@@ -37274,7 +37274,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -37309,7 +37309,7 @@ paths:
- key_id
- key
examples:
- default: &478
+ default: &475
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -37722,7 +37722,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *85
- - &462
+ - &459
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)."
@@ -38961,12 +38961,12 @@ paths:
required:
- subject_digests
examples:
- default: &812
+ default: &807
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &813
+ withPredicateType: &808
value:
subject_digests:
- sha256:abc123
@@ -39025,7 +39025,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &814
+ default: &809
value:
attestations_subject_digests:
- sha256:abc:
@@ -39374,7 +39374,7 @@ paths:
initiator:
type: string
examples:
- default: &491
+ default: &488
value:
attestations:
- bundle:
@@ -40296,7 +40296,7 @@ paths:
be returned.
in: query
required: false
- schema: &516
+ schema: &513
type: string
description: Severity of a code scanning alert.
enum:
@@ -41355,7 +41355,7 @@ paths:
machine:
anyOf:
- type: 'null'
- - &548
+ - &545
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
@@ -42307,7 +42307,7 @@ paths:
- updated_at
- visibility
examples:
- default: &549
+ default: &546
value:
total_count: 2
secrets:
@@ -42345,7 +42345,7 @@ paths:
description: Response
content:
application/json:
- schema: &550
+ schema: &547
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -42380,7 +42380,7 @@ paths:
- key_id
- key
examples:
- default: &551
+ default: &548
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -42412,7 +42412,7 @@ paths:
application/json:
schema: *316
examples:
- default: &553
+ default: &550
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -44291,7 +44291,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -44310,7 +44310,7 @@ paths:
- key_id
- key
examples:
- default: &580
+ default: &577
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -44640,7 +44640,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *85
- - &588
+ - &585
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -44648,7 +44648,7 @@ paths:
required: false
schema:
type: string
- - &589
+ - &586
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -44656,7 +44656,7 @@ paths:
required: false
schema:
type: string
- - &590
+ - &587
name: time_period
description: |-
The time period to filter by.
@@ -44672,7 +44672,7 @@ paths:
- week
- month
default: month
- - &591
+ - &588
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -44697,7 +44697,7 @@ paths:
application/json:
schema:
type: array
- items: &592
+ items: &589
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -44860,7 +44860,7 @@ paths:
examples:
- https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &593
+ default: &590
value:
- id: 21
number: 42
@@ -44978,7 +44978,7 @@ paths:
application/json:
schema:
type: array
- items: &594
+ items: &591
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -45101,7 +45101,7 @@ paths:
examples:
- https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &595
+ default: &592
value:
- id: 21
number: 42
@@ -45203,7 +45203,7 @@ paths:
application/json:
schema:
type: array
- items: &596
+ items: &593
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -45330,7 +45330,7 @@ paths:
examples:
- https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &597
+ default: &594
value:
- id: 21
number: 42
@@ -45676,7 +45676,7 @@ paths:
description: Response
content:
application/json:
- schema: &441
+ schema: &438
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -45766,7 +45766,7 @@ paths:
member_name: Octo Lisa
member_email: octo_lisa@github.com
examples:
- default: &442
+ default: &439
value:
group_id: '123'
group_name: Octocat admins
@@ -45821,7 +45821,7 @@ paths:
description: Response
content:
application/json:
- schema: &439
+ schema: &436
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -45861,7 +45861,7 @@ paths:
group_name: group-azuread-test2
updated_at: 2021-06-03 22:27:15:000 -700
examples:
- default: &440
+ default: &437
value:
groups:
- group_id: '123'
@@ -47190,7 +47190,7 @@ paths:
application/json:
schema: *20
examples:
- default: &628
+ default: &625
value:
id: 1
account:
@@ -47418,7 +47418,7 @@ paths:
required: true
content:
application/json:
- schema: &629
+ schema: &626
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -48286,7 +48286,7 @@ paths:
application/json:
schema: *363
examples:
- default: &547
+ default: &544
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -49548,7 +49548,7 @@ paths:
parameters:
- *85
- *369
- - &797
+ - &792
name: repo_name
description: repo_name parameter
in: path
@@ -50894,7 +50894,7 @@ paths:
- nuget
- container
- *85
- - &798
+ - &793
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -50935,7 +50935,7 @@ paths:
default: *374
'403': *27
'401': *23
- '400': &800
+ '400': &795
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -52761,7 +52761,7 @@ paths:
latest_status_update:
anyOf:
- type: 'null'
- - &884
+ - &879
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -53035,7 +53035,7 @@ paths:
content:
oneOf:
- *212
- - &562
+ - &559
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -53280,7 +53280,7 @@ paths:
- review_comment
- self
author_association: *213
- auto_merge: &675
+ auto_merge: &672
title: Auto merge
description: The status of auto merging a pull request.
type:
@@ -53662,7 +53662,7 @@ paths:
- updated_at
- project_url
examples:
- default: &817
+ default: &812
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53839,7 +53839,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &818
+ items: &813
type: object
properties:
name:
@@ -53875,7 +53875,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &819
+ iteration_configuration: &814
type: object
description: The configuration for iteration fields.
properties:
@@ -53924,7 +53924,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &820
+ single_select_field: &815
summary: Create a single select field
value:
name: Priority
@@ -53951,7 +53951,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &821
+ iteration_field: &816
summary: Create an iteration field
value:
name: Sprint
@@ -53977,7 +53977,7 @@ paths:
application/json:
schema: *394
examples:
- text_field: &822
+ text_field: &817
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -53986,7 +53986,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: &823
+ number_field: &818
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -53995,7 +53995,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: &824
+ date_field: &819
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -54004,7 +54004,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: &825
+ single_select_field: &820
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -54038,7 +54038,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &826
+ iteration_field: &821
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -54084,7 +54084,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *391
- - &827
+ - &822
name: field_id
description: The unique identifier of the field.
in: path
@@ -54099,7 +54099,7 @@ paths:
application/json:
schema: *394
examples:
- default: &828
+ default: &823
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -55232,7 +55232,7 @@ paths:
parameters:
- *391
- *85
- - &829
+ - &824
name: view_number
description: The number that identifies the project view.
in: path
@@ -56002,7 +56002,7 @@ paths:
description: Response
content:
application/json:
- schema: &449
+ schema: &446
title: Full Repository
description: Full Repository
type: object
@@ -56467,7 +56467,7 @@ paths:
description: Whether anonymous git access is allowed.
default: true
type: boolean
- code_of_conduct: &567
+ code_of_conduct: &564
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
@@ -56581,7 +56581,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &451
+ default: &448
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -57134,7 +57134,7 @@ paths:
- *85
- *17
- *19
- - &697
+ - &694
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -57350,7 +57350,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *85
- - &699
+ - &696
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
@@ -57362,14 +57362,14 @@ paths:
x-multi-segment: true
- *298
- *103
- - &700
+ - &697
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
- - &701
+ - &698
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -57389,7 +57389,7 @@ paths:
description: Response
content:
application/json:
- schema: &702
+ schema: &699
title: Rule Suites
description: Response
type: array
@@ -57445,7 +57445,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &703
+ default: &700
value:
- id: 21
actor_id: 12
@@ -57489,7 +57489,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *85
- - &704
+ - &701
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -57505,7 +57505,7 @@ paths:
description: Response
content:
application/json:
- schema: &705
+ schema: &702
title: Rule Suite
description: Response
type: object
@@ -57612,7 +57612,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &706
+ default: &703
value:
id: 21
actor_id: 12
@@ -57944,7 +57944,7 @@ paths:
- *108
- *19
- *17
- - &708
+ - &705
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
@@ -57954,7 +57954,7 @@ paths:
required: false
schema:
type: string
- - &709
+ - &706
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
@@ -58167,7 +58167,7 @@ paths:
application/json:
schema:
type: array
- items: &730
+ items: &727
description: A repository security advisory.
type: object
properties:
@@ -58486,7 +58486,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &731
+ default: &728
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -59497,7 +59497,7 @@ paths:
description: Response
content:
application/json:
- schema: &446
+ schema: &443
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -59549,7 +59549,7 @@ paths:
group_description: Another group of Developers working on AzureAD
SAML SSO
examples:
- default: &447
+ default: &444
value:
groups:
- group_id: '123'
@@ -60425,15 +60425,6 @@ paths:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -60496,8 +60487,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -60510,7 +60499,7 @@ paths:
- updated_at
- url
examples:
- default: &774
+ default: &771
value:
- author:
login: octocat
@@ -60535,8 +60524,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
@@ -60646,8 +60633,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
@@ -60758,7 +60743,7 @@ paths:
application/json:
schema: *433
examples:
- default: &775
+ default: &772
value:
author:
login: octocat
@@ -60783,8 +60768,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
@@ -60839,418 +60822,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:
- - *85
- - *209
- - *435
- - *108
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &436
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- anyOf:
- - type: 'null'
- - *4
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *214
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &776
- 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: *45
- 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:
- - *85
- - *209
- - *435
- 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: *436
- examples:
- default: &437
- 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:
- - *85
- - *209
- - *435
- - &438
- 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: *436
- examples:
- default: *437
- 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:
- - *85
- - *209
- - *435
- - *438
- 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: *436
- examples:
- default: &777
- 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:
- - *85
- - *209
- - *435
- - *438
- 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
@@ -61272,9 +60843,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -61318,9 +60889,9 @@ paths:
description: Response
content:
application/json:
- schema: *441
+ schema: *438
examples:
- default: *442
+ default: *439
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -61461,7 +61032,7 @@ paths:
description: Response
content:
application/json:
- schema: &443
+ schema: &440
title: Team Membership
description: Team Membership
type: object
@@ -61489,7 +61060,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &778
+ response-if-user-is-a-team-maintainer: &773
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -61552,9 +61123,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-users-membership-with-team-is-now-pending: &779
+ response-if-users-membership-with-team-is-now-pending: &774
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -61661,14 +61232,14 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &780
+ schema: &775
title: Team Repository
description: A team's access to a repository.
type: object
@@ -62311,8 +61882,8 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -62359,8 +61930,8 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -62393,9 +61964,9 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
- default: *447
+ default: *444
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -62461,7 +62032,7 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -62506,7 +62077,7 @@ paths:
type: array
items: *301
examples:
- response-if-child-teams-exist: &781
+ response-if-child-teams-exist: &776
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -62660,7 +62231,7 @@ paths:
resources:
type: object
properties:
- core: &448
+ core: &445
title: Rate Limit
type: object
properties:
@@ -62677,21 +62248,21 @@ paths:
- remaining
- reset
- used
- graphql: *448
- search: *448
- code_search: *448
- source_import: *448
- integration_manifest: *448
- code_scanning_upload: *448
- actions_runner_registration: *448
- scim: *448
- dependency_snapshots: *448
- dependency_sbom: *448
- code_scanning_autofix: *448
+ graphql: *445
+ search: *445
+ code_search: *445
+ source_import: *445
+ integration_manifest: *445
+ code_scanning_upload: *445
+ actions_runner_registration: *445
+ scim: *445
+ dependency_snapshots: *445
+ dependency_sbom: *445
+ code_scanning_autofix: *445
required:
- core
- search
- rate: *448
+ rate: *445
required:
- rate
- resources
@@ -62796,14 +62367,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default-response:
summary: Default response
@@ -63308,7 +62879,7 @@ paths:
status: disabled
'403': *27
'404': *6
- '301': *450
+ '301': *447
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63326,8 +62897,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -63585,10 +63156,10 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
- '307': &452
+ default: *448
+ '307': &449
description: Temporary Redirect
content:
application/json:
@@ -63617,8 +63188,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -63640,7 +63211,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
- '307': *452
+ '307': *449
'404': *6
'409': *116
x-github:
@@ -63664,11 +63235,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- - &469
+ - &466
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -63691,7 +63262,7 @@ paths:
type: integer
artifacts:
type: array
- items: &453
+ items: &450
title: Artifact
description: An artifact
type: object
@@ -63786,7 +63357,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &470
+ default: &467
value:
total_count: 2
artifacts:
@@ -63847,9 +63418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *444
- - *445
- - &454
+ - *441
+ - *442
+ - &451
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -63861,7 +63432,7 @@ paths:
description: Response
content:
application/json:
- schema: *453
+ schema: *450
examples:
default:
value:
@@ -63899,9 +63470,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *444
- - *445
- - *454
+ - *441
+ - *442
+ - *451
responses:
'204':
description: Response
@@ -63925,9 +63496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *444
- - *445
- - *454
+ - *441
+ - *442
+ - *451
- name: archive_format
in: path
required: true
@@ -63941,7 +63512,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': &632
+ '410': &629
description: Gone
content:
application/json:
@@ -63966,14 +63537,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &455
+ schema: &452
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -64007,13 +63578,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *455
+ schema: *452
examples:
selected_actions: *42
responses:
@@ -64042,14 +63613,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -64083,13 +63654,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *456
+ schema: *453
examples:
selected_actions: *44
responses:
@@ -64120,14 +63691,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
default:
value:
@@ -64153,11 +63724,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:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- - &458
+ - &455
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
@@ -64191,7 +63762,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: Repository actions caches
description: Repository actions caches
type: object
@@ -64241,7 +63812,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &460
+ default: &457
value:
total_count: 1
actions_caches:
@@ -64273,23 +63844,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:
- - *444
- - *445
+ - *441
+ - *442
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *458
+ - *455
responses:
'200':
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64309,8 +63880,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:
- - *444
- - *445
+ - *441
+ - *442
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -64341,9 +63912,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:
- - *444
- - *445
- - &461
+ - *441
+ - *442
+ - &458
name: job_id
description: The unique identifier of the job.
in: path
@@ -64355,7 +63926,7 @@ paths:
description: Response
content:
application/json:
- schema: &473
+ schema: &470
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -64702,9 +64273,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:
- - *444
- - *445
- - *461
+ - *441
+ - *442
+ - *458
responses:
'302':
description: Response
@@ -64732,9 +64303,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:
- - *444
- - *445
- - *461
+ - *441
+ - *442
+ - *458
requestBody:
required: false
content:
@@ -64780,8 +64351,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Status response
@@ -64831,8 +64402,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -64895,8 +64466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -64914,7 +64485,7 @@ paths:
type: integer
secrets:
type: array
- items: &475
+ items: &472
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -64935,7 +64506,7 @@ paths:
- created_at
- updated_at
examples:
- default: &476
+ default: &473
value:
total_count: 2
secrets:
@@ -64968,9 +64539,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *444
- - *445
- - *462
+ - *441
+ - *442
+ - *459
- *19
responses:
'200':
@@ -64987,7 +64558,7 @@ paths:
type: integer
variables:
type: array
- items: &479
+ items: &476
title: Actions Variable
type: object
properties:
@@ -65021,7 +64592,7 @@ paths:
- created_at
- updated_at
examples:
- default: &480
+ default: &477
value:
total_count: 2
variables:
@@ -65054,8 +64625,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65064,7 +64635,7 @@ paths:
schema:
type: object
properties:
- enabled: &463
+ enabled: &460
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *58
@@ -65099,8 +64670,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65111,7 +64682,7 @@ paths:
schema:
type: object
properties:
- enabled: *463
+ enabled: *460
allowed_actions: *58
sha_pinning_required: *59
required:
@@ -65144,14 +64715,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &464
+ schema: &461
type: object
properties:
access_level:
@@ -65169,7 +64740,7 @@ paths:
required:
- access_level
examples:
- default: &465
+ default: &462
value:
access_level: organization
x-github:
@@ -65194,15 +64765,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
responses:
'204':
description: Response
@@ -65226,8 +64797,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65257,8 +64828,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Empty response for successful settings update
@@ -65292,8 +64863,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65320,8 +64891,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65355,8 +64926,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65384,8 +64955,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -65416,8 +64987,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65448,8 +65019,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65481,8 +65052,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65511,8 +65082,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Success response
@@ -65552,8 +65123,8 @@ paths:
in: query
schema:
type: string
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -65597,8 +65168,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65630,8 +65201,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -65705,8 +65276,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -65742,8 +65313,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -65773,8 +65344,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200':
@@ -65804,8 +65375,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'204':
@@ -65832,8 +65403,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200': *79
@@ -65858,8 +65429,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
requestBody:
required: true
@@ -65908,8 +65479,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
requestBody:
required: true
@@ -65959,8 +65530,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200': *279
@@ -65990,8 +65561,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
- *280
responses:
@@ -66021,9 +65592,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:
- - *444
- - *445
- - &483
+ - *441
+ - *442
+ - &480
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.
@@ -66031,7 +65602,7 @@ paths:
required: false
schema:
type: string
- - &484
+ - &481
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -66039,7 +65610,7 @@ paths:
required: false
schema:
type: string
- - &485
+ - &482
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -66048,7 +65619,7 @@ paths:
required: false
schema:
type: string
- - &486
+ - &483
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
@@ -66075,7 +65646,7 @@ paths:
- pending
- *17
- *19
- - &487
+ - &484
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)."
@@ -66084,7 +65655,7 @@ paths:
schema:
type: string
format: date-time
- - &466
+ - &463
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -66093,13 +65664,13 @@ paths:
schema:
type: boolean
default: false
- - &488
+ - &485
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &489
+ - &486
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -66122,7 +65693,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &467
+ items: &464
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -66300,7 +65871,7 @@ paths:
head_commit:
anyOf:
- type: 'null'
- - &511
+ - &508
title: Simple Commit
description: A commit.
type: object
@@ -66415,7 +65986,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &490
+ default: &487
value:
total_count: 1
workflow_runs:
@@ -66651,24 +66222,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *444
- - *445
- - &468
+ - *441
+ - *442
+ - &465
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *466
+ - *463
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: &471
+ default: &468
value:
id: 30433642
name: Build
@@ -66909,9 +66480,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'204':
description: Response
@@ -66934,9 +66505,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -67064,9 +66635,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'201':
description: Response
@@ -67099,12 +66670,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
- *17
- *19
- - *469
+ - *466
responses:
'200':
description: Response
@@ -67120,9 +66691,9 @@ paths:
type: integer
artifacts:
type: array
- items: *453
+ items: *450
examples:
- default: *470
+ default: *467
headers:
Link: *45
x-github:
@@ -67146,25 +66717,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *444
- - *445
- - *468
- - &472
+ - *441
+ - *442
+ - *465
+ - &469
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *466
+ - *463
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *471
+ default: *468
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67187,10 +66758,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:
- - *444
- - *445
- - *468
- - *472
+ - *441
+ - *442
+ - *465
+ - *469
- *17
- *19
responses:
@@ -67208,9 +66779,9 @@ paths:
type: integer
jobs:
type: array
- items: *473
+ items: *470
examples:
- default: &474
+ default: &471
value:
total_count: 1
jobs:
@@ -67323,10 +66894,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *444
- - *445
- - *468
- - *472
+ - *441
+ - *442
+ - *465
+ - *469
responses:
'302':
description: Response
@@ -67354,9 +66925,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'202':
description: Response
@@ -67389,9 +66960,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: true
content:
@@ -67458,9 +67029,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'202':
description: Response
@@ -67493,9 +67064,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
- 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
@@ -67525,9 +67096,9 @@ paths:
type: integer
jobs:
type: array
- items: *473
+ items: *470
examples:
- default: *474
+ default: *471
headers:
Link: *45
x-github:
@@ -67552,9 +67123,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'302':
description: Response
@@ -67581,9 +67152,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'204':
description: Response
@@ -67610,9 +67181,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -67681,7 +67252,7 @@ paths:
items:
type: object
properties:
- type: &598
+ type: &595
type: string
description: The type of reviewer.
enum:
@@ -67767,9 +67338,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: true
content:
@@ -67819,7 +67390,7 @@ paths:
application/json:
schema:
type: array
- items: &583
+ items: &580
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -67931,7 +67502,7 @@ paths:
- created_at
- updated_at
examples:
- default: &584
+ default: &581
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -67987,9 +67558,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: false
content:
@@ -68034,9 +67605,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: false
content:
@@ -68091,9 +67662,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -68230,8 +67801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -68249,9 +67820,9 @@ paths:
type: integer
secrets:
type: array
- items: *475
+ items: *472
examples:
- default: *476
+ default: *473
headers:
Link: *45
x-github:
@@ -68276,16 +67847,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68307,17 +67878,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
- default: &611
+ default: &608
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -68343,8 +67914,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -68402,8 +67973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -68429,9 +68000,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *444
- - *445
- - *462
+ - *441
+ - *442
+ - *459
- *19
responses:
'200':
@@ -68448,9 +68019,9 @@ paths:
type: integer
variables:
type: array
- items: *479
+ items: *476
examples:
- default: *480
+ default: *477
headers:
Link: *45
x-github:
@@ -68473,8 +68044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -68526,17 +68097,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
responses:
'200':
description: Response
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: &612
+ default: &609
value:
name: USERNAME
value: octocat
@@ -68562,8 +68133,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
requestBody:
required: true
@@ -68606,8 +68177,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
responses:
'204':
@@ -68633,8 +68204,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -68652,7 +68223,7 @@ paths:
type: integer
workflows:
type: array
- items: &481
+ items: &478
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -68770,9 +68341,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *444
- - *445
- - &482
+ - *441
+ - *442
+ - &479
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -68787,7 +68358,7 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
default:
value:
@@ -68820,9 +68391,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68847,9 +68418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68900,9 +68471,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68929,19 +68500,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:
- - *444
- - *445
+ - *441
+ - *442
+ - *479
+ - *480
+ - *481
- *482
- *483
+ - *17
+ - *19
- *484
+ - *463
- *485
- *486
- - *17
- - *19
- - *487
- - *466
- - *488
- - *489
responses:
'200':
description: Response
@@ -68957,9 +68528,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *467
+ items: *464
examples:
- default: *490
+ default: *487
headers:
Link: *45
x-github:
@@ -68992,9 +68563,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'200':
description: Response
@@ -69055,8 +68626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *108
- *17
- *106
@@ -69224,8 +68795,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -69262,8 +68833,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:
- - *444
- - *445
+ - *441
+ - *442
- name: assignee
in: path
required: true
@@ -69299,8 +68870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -69412,8 +68983,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *106
- *107
@@ -69470,7 +69041,7 @@ paths:
initiator:
type: string
examples:
- default: *491
+ default: *488
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69490,8 +69061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -69499,7 +69070,7 @@ paths:
application/json:
schema:
type: array
- items: &492
+ items: &489
title: Autolink reference
description: An autolink reference.
type: object
@@ -69558,8 +69129,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -69598,9 +69169,9 @@ paths:
description: response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: &493
+ default: &490
value:
id: 1
key_prefix: TICKET-
@@ -69631,9 +69202,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:
- - *444
- - *445
- - &494
+ - *441
+ - *442
+ - &491
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -69645,9 +69216,9 @@ paths:
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
'404': *6
x-github:
githubCloudOnly: false
@@ -69667,9 +69238,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:
- - *444
- - *445
- - *494
+ - *441
+ - *442
+ - *491
responses:
'204':
description: Response
@@ -69693,8 +69264,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response if Dependabot is enabled
@@ -69744,8 +69315,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -69766,8 +69337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -69787,8 +69358,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -69826,7 +69397,7 @@ paths:
- url
protected:
type: boolean
- protection: &496
+ protection: &493
title: Branch Protection
description: Branch Protection
type: object
@@ -69869,7 +69440,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &499
+ enforce_admins: &496
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -69886,7 +69457,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &501
+ required_pull_request_reviews: &498
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -69970,7 +69541,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &498
+ restrictions: &495
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -70263,9 +69834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *444
- - *445
- - &497
+ - *441
+ - *442
+ - &494
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).
@@ -70279,14 +69850,14 @@ paths:
description: Response
content:
application/json:
- schema: &507
+ schema: &504
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &558
+ commit: &555
title: Commit
description: Commit
type: object
@@ -70325,7 +69896,7 @@ paths:
author:
anyOf:
- type: 'null'
- - &495
+ - &492
title: Git User
description: Metaproperties for Git author/committer
information.
@@ -70347,7 +69918,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
message:
type: string
examples:
@@ -70371,7 +69942,7 @@ paths:
required:
- sha
- url
- verification: &618
+ verification: &615
title: Verification
type: object
properties:
@@ -70451,7 +70022,7 @@ paths:
type: integer
files:
type: array
- items: &569
+ items: &566
title: Diff Entry
description: Diff Entry
type: object
@@ -70547,7 +70118,7 @@ paths:
- self
protected:
type: boolean
- protection: *496
+ protection: *493
protection_url:
type: string
format: uri
@@ -70656,7 +70227,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *450
+ '301': *447
'404': *6
x-github:
githubCloudOnly: false
@@ -70678,15 +70249,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
default:
value:
@@ -70880,9 +70451,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -71142,7 +70713,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &504
+ required_status_checks: &501
title: Status Check Policy
description: Status Check Policy
type: object
@@ -71301,7 +70872,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *498
+ restrictions: *495
required_conversation_resolution:
type: object
properties:
@@ -71413,9 +70984,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71440,17 +71011,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &500
+ default: &497
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -71472,17 +71043,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71501,9 +71072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71528,17 +71099,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: &502
+ default: &499
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -71634,9 +71205,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -71734,9 +71305,9 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: *502
+ default: *499
'422': *15
x-github:
githubCloudOnly: false
@@ -71757,9 +71328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71786,17 +71357,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &503
+ default: &500
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -71819,17 +71390,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *503
+ default: *500
'404': *6
x-github:
githubCloudOnly: false
@@ -71849,9 +71420,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71876,17 +71447,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: &505
+ default: &502
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -71912,9 +71483,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -71966,9 +71537,9 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: *505
+ default: *502
'404': *6
'422': *15
x-github:
@@ -71990,9 +71561,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -72016,9 +71587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72052,9 +71623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72121,9 +71692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72187,9 +71758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
content:
application/json:
@@ -72255,15 +71826,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
default:
value:
@@ -72354,9 +71925,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -72379,9 +71950,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72391,7 +71962,7 @@ paths:
type: array
items: *5
examples:
- default: &506
+ default: &503
value:
- id: 1
slug: octoapp
@@ -72448,9 +72019,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72484,7 +72055,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72505,9 +72076,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72541,7 +72112,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72562,9 +72133,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72598,7 +72169,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72620,9 +72191,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72652,9 +72223,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72713,9 +72284,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72774,9 +72345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
content:
application/json:
@@ -72835,9 +72406,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72871,9 +72442,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72931,9 +72502,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72991,9 +72562,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -73053,9 +72624,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -73077,7 +72648,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
default:
value:
@@ -73191,8 +72762,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -73228,8 +72799,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73302,8 +72873,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -73343,8 +72914,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73414,8 +72985,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73486,8 +73057,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_response_id
in: path
required: true
@@ -73520,8 +73091,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -73800,7 +73371,7 @@ paths:
description: Response
content:
application/json:
- schema: &508
+ schema: &505
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -73936,7 +73507,7 @@ paths:
check.
type: array
items: *216
- deployment: &840
+ deployment: &835
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -74223,9 +73794,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *444
- - *445
- - &509
+ - *441
+ - *442
+ - &506
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -74237,9 +73808,9 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
- default: &510
+ default: &507
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -74339,9 +73910,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
requestBody:
required: true
content:
@@ -74581,9 +74152,9 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
- default: *510
+ default: *507
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74603,9 +74174,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
- *17
- *19
responses:
@@ -74715,9 +74286,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
responses:
'201':
description: Response
@@ -74761,8 +74332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -74784,7 +74355,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &512
+ schema: &509
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -74882,7 +74453,7 @@ paths:
- string
- 'null'
format: date-time
- head_commit: *511
+ head_commit: *508
latest_check_runs_count:
type: integer
check_runs_url:
@@ -74910,7 +74481,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &513
+ default: &510
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -75201,9 +74772,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *512
+ schema: *509
examples:
- default: *513
+ default: *510
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75222,8 +74793,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -75532,9 +75103,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *444
- - *445
- - &514
+ - *441
+ - *442
+ - &511
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -75546,9 +75117,9 @@ paths:
description: Response
content:
application/json:
- schema: *512
+ schema: *509
examples:
- default: *513
+ default: *510
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75571,17 +75142,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:
- - *444
- - *445
- - *514
- - &564
+ - *441
+ - *442
+ - *511
+ - &561
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &565
+ - &562
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -75620,9 +75191,9 @@ paths:
type: integer
check_runs:
type: array
- items: *508
+ items: *505
examples:
- default: &566
+ default: &563
value:
total_count: 1
check_runs:
@@ -75724,9 +75295,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *444
- - *445
- - *514
+ - *441
+ - *442
+ - *511
responses:
'201':
description: Response
@@ -75759,21 +75330,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:
- - *444
- - *445
+ - *441
+ - *442
- *305
- *306
- *19
- *17
- - &530
+ - &527
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: *515
- - &531
+ schema: *512
+ - &528
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -75804,7 +75375,7 @@ paths:
be returned.
in: query
required: false
- schema: *516
+ schema: *513
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -75828,7 +75399,7 @@ paths:
updated_at: *131
url: *128
html_url: *129
- instances_url: *517
+ instances_url: *514
state: *111
fixed_at: *133
dismissed_by:
@@ -75836,11 +75407,11 @@ paths:
- type: 'null'
- *4
dismissed_at: *132
- dismissed_reason: *518
- dismissed_comment: *519
- rule: *520
- tool: *521
- most_recent_instance: *522
+ dismissed_reason: *515
+ dismissed_comment: *516
+ rule: *517
+ tool: *518
+ most_recent_instance: *519
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -75963,7 +75534,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *35
- '403': &523
+ '403': &520
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -75990,9 +75561,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:
- - *444
- - *445
- - &524
+ - *441
+ - *442
+ - &521
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -76006,7 +75577,7 @@ paths:
description: Response
content:
application/json:
- schema: &525
+ schema: &522
type: object
properties:
number: *123
@@ -76014,7 +75585,7 @@ paths:
updated_at: *131
url: *128
html_url: *129
- instances_url: *517
+ instances_url: *514
state: *111
fixed_at: *133
dismissed_by:
@@ -76022,8 +75593,8 @@ paths:
- type: 'null'
- *4
dismissed_at: *132
- dismissed_reason: *518
- dismissed_comment: *519
+ dismissed_reason: *515
+ dismissed_comment: *516
rule:
type: object
properties:
@@ -76085,8 +75656,8 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: *521
- most_recent_instance: *522
+ tool: *518
+ most_recent_instance: *519
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -76182,7 +75753,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *35
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76202,9 +75773,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: true
content:
@@ -76219,8 +75790,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *518
- dismissed_comment: *519
+ dismissed_reason: *515
+ dismissed_comment: *516
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -76248,7 +75819,7 @@ paths:
description: Response
content:
application/json:
- schema: *525
+ schema: *522
examples:
default:
value:
@@ -76324,7 +75895,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &529
+ '403': &526
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -76351,15 +75922,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
responses:
'200':
description: Response
content:
application/json:
- schema: &526
+ schema: &523
type: object
properties:
status:
@@ -76386,13 +75957,13 @@ paths:
- description
- started_at
examples:
- default: &527
+ default: &524
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &528
+ '400': &525
description: Bad Request
content:
application/json:
@@ -76403,7 +75974,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': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76428,29 +75999,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
responses:
'200':
description: OK
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: *527
+ default: *524
'202':
description: Accepted
content:
application/json:
- schema: *526
+ schema: *523
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *528
+ '400': *525
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -76482,9 +76053,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: false
content:
@@ -76530,8 +76101,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *528
- '403': *529
+ '400': *525
+ '403': *526
'404': *6
'422':
description: Unprocessable Entity
@@ -76555,13 +76126,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *19
- *17
- - *530
- - *531
+ - *527
+ - *528
responses:
'200':
description: Response
@@ -76572,10 +76143,10 @@ paths:
items:
type: object
properties:
- ref: *515
- analysis_key: *532
- environment: *533
- category: *534
+ ref: *512
+ analysis_key: *529
+ environment: *530
+ category: *531
state:
type:
- string
@@ -76592,7 +76163,7 @@ paths:
properties:
text:
type: string
- location: *535
+ location: *532
html_url:
type: string
classifications:
@@ -76600,7 +76171,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: *536
+ items: *533
examples:
default:
value:
@@ -76639,7 +76210,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76673,25 +76244,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:
- - *444
- - *445
+ - *441
+ - *442
- *305
- *306
- *19
- *17
- - *531
+ - *528
- 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: *515
+ schema: *512
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &537
+ schema: &534
type: string
description: An identifier for the upload.
examples:
@@ -76713,23 +76284,23 @@ paths:
application/json:
schema:
type: array
- items: &538
+ items: &535
type: object
properties:
- ref: *515
- commit_sha: &546
+ ref: *512
+ commit_sha: &543
description: The SHA of the commit to which the analysis you
are uploading relates.
type: string
minLength: 40
maxLength: 40
pattern: "^[0-9a-fA-F]+$"
- analysis_key: *532
+ analysis_key: *529
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *534
+ category: *531
error:
type: string
examples:
@@ -76754,8 +76325,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *537
- tool: *521
+ sarif_id: *534
+ tool: *518
deletable:
type: boolean
warning:
@@ -76817,7 +76388,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76853,8 +76424,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:
- - *444
- - *445
+ - *441
+ - *442
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -76867,7 +76438,7 @@ paths:
description: Response
content:
application/json:
- schema: *538
+ schema: *535
examples:
response:
summary: application/json response
@@ -76921,7 +76492,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *523
+ '403': *520
'404': *6
'422':
description: Response if analysis could not be processed
@@ -77008,8 +76579,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:
- - *444
- - *445
+ - *441
+ - *442
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -77065,7 +76636,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': *529
+ '403': *526
'404': *6
'503': *189
x-github:
@@ -77087,8 +76658,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -77096,7 +76667,7 @@ paths:
application/json:
schema:
type: array
- items: &539
+ items: &536
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -77208,7 +76779,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': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -77237,8 +76808,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:
- - *444
- - *445
+ - *441
+ - *442
- name: language
in: path
description: The language of the CodeQL database.
@@ -77250,7 +76821,7 @@ paths:
description: Response
content:
application/json:
- schema: *539
+ schema: *536
examples:
default:
value:
@@ -77282,9 +76853,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': &571
+ '302': &568
description: Found
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -77306,8 +76877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: language
in: path
description: The language of the CodeQL database.
@@ -77317,7 +76888,7 @@ paths:
responses:
'204':
description: Response
- '403': *529
+ '403': *526
'404': *6
'503': *189
x-github:
@@ -77345,8 +76916,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -77355,7 +76926,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &540
+ language: &537
type: string
description: The language targeted by the CodeQL query
enum:
@@ -77435,7 +77006,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &544
+ schema: &541
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -77445,7 +77016,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *117
actor: *4
- query_language: *540
+ query_language: *537
query_pack_url:
type: string
description: The download url for the query pack.
@@ -77493,7 +77064,7 @@ paths:
items:
type: object
properties:
- repository: &541
+ repository: &538
title: Repository Identifier
description: Repository Identifier
type: object
@@ -77535,7 +77106,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &545
+ analysis_status: &542
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -77567,7 +77138,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &542
+ access_mismatch_repos: &539
type: object
properties:
repository_count:
@@ -77582,7 +77153,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: *541
+ items: *538
required:
- repository_count
- repositories
@@ -77605,8 +77176,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *542
- over_limit_repos: *542
+ no_codeql_db_repos: *539
+ over_limit_repos: *539
required:
- access_mismatch_repos
- not_found_repos
@@ -77622,7 +77193,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &543
+ value: &540
summary: Default response
value:
id: 1
@@ -77768,10 +77339,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *543
+ value: *540
repository_lists:
summary: Response for a successful variant analysis submission
- value: *543
+ value: *540
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -77799,8 +77370,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:
- - *444
- - *445
+ - *441
+ - *442
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -77812,9 +77383,9 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
- default: *543
+ default: *540
'404': *6
'503': *189
x-github:
@@ -77837,7 +77408,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:
- - *444
+ - *441
- name: repo
in: path
description: The name of the controller repository.
@@ -77872,7 +77443,7 @@ paths:
type: object
properties:
repository: *117
- analysis_status: *545
+ analysis_status: *542
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -77997,8 +77568,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78091,7 +77662,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -78112,8 +77683,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -78207,7 +77778,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *529
+ '403': *526
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -78278,8 +77849,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -78287,7 +77858,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *546
+ commit_sha: *543
ref:
type: string
description: |-
@@ -78347,7 +77918,7 @@ paths:
schema:
type: object
properties:
- id: *537
+ id: *534
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -78361,7 +77932,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': *529
+ '403': *526
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -78384,8 +77955,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:
- - *444
- - *445
+ - *441
+ - *442
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -78433,7 +78004,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': *523
+ '403': *520
'404':
description: Not Found if the sarif id does not match any upload
'503': *189
@@ -78458,8 +78029,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78540,8 +78111,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -78669,8 +78240,8 @@ paths:
parameters:
- *17
- *19
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78984,8 +78555,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -79051,7 +78622,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -79059,7 +78630,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'400': *14
'401': *23
'403': *27
@@ -79088,8 +78659,8 @@ paths:
parameters:
- *17
- *19
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -79153,8 +78724,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:
- - *444
- - *445
+ - *441
+ - *442
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -79191,9 +78762,9 @@ paths:
type: integer
machines:
type: array
- items: *548
+ items: *545
examples:
- default: &788
+ default: &783
value:
total_count: 2
machines:
@@ -79233,8 +78804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -79321,8 +78892,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:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -79391,8 +78962,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -79410,7 +78981,7 @@ paths:
type: integer
secrets:
type: array
- items: &552
+ items: &549
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -79431,7 +79002,7 @@ paths:
- created_at
- updated_at
examples:
- default: *549
+ default: *546
headers:
Link: *45
x-github:
@@ -79454,16 +79025,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *550
+ schema: *547
examples:
- default: *551
+ default: *548
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -79483,17 +79054,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *552
+ schema: *549
examples:
- default: *553
+ default: *550
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79513,8 +79084,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:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -79567,8 +79138,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -79597,8 +79168,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -79636,7 +79207,7 @@ paths:
application/json:
schema:
type: array
- items: &554
+ items: &551
title: Collaborator
description: Collaborator
type: object
@@ -79829,8 +79400,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:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'204':
@@ -79877,8 +79448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
requestBody:
required: false
@@ -79905,7 +79476,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &631
+ schema: &628
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -80133,8 +79704,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'204':
@@ -80166,8 +79737,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'200':
@@ -80188,7 +79759,7 @@ paths:
user:
anyOf:
- type: 'null'
- - *554
+ - *551
required:
- permission
- role_name
@@ -80242,8 +79813,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -80253,7 +79824,7 @@ paths:
application/json:
schema:
type: array
- items: &555
+ items: &552
title: Commit Comment
description: Commit Comment
type: object
@@ -80311,7 +79882,7 @@ paths:
- created_at
- updated_at
examples:
- default: &560
+ default: &557
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -80370,17 +79941,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: &561
+ default: &558
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -80437,8 +80008,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -80461,7 +80032,7 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
default:
value:
@@ -80512,8 +80083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -80535,8 +80106,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -80563,7 +80134,7 @@ paths:
application/json:
schema:
type: array
- items: &556
+ items: &553
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -80607,7 +80178,7 @@ paths:
- content
- created_at
examples:
- default: &635
+ default: &632
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -80652,8 +80223,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -80686,9 +80257,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: &557
+ default: &554
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -80717,9 +80288,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -80741,10 +80312,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - &636
+ - &633
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -80799,8 +80370,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -80856,9 +80427,9 @@ paths:
application/json:
schema:
type: array
- items: *558
+ items: *555
examples:
- default: &682
+ default: &679
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -80952,9 +80523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *444
- - *445
- - &559
+ - *441
+ - *442
+ - &556
name: commit_sha
description: The SHA of the commit.
in: path
@@ -81026,9 +80597,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
- *17
- *19
responses:
@@ -81038,9 +80609,9 @@ paths:
application/json:
schema:
type: array
- items: *555
+ items: *552
examples:
- default: *560
+ default: *557
headers:
Link: *45
x-github:
@@ -81068,9 +80639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
requestBody:
required: true
content:
@@ -81105,9 +80676,9 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *561
+ default: *558
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -81135,9 +80706,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:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
- *17
- *19
responses:
@@ -81147,9 +80718,9 @@ paths:
application/json:
schema:
type: array
- items: *562
+ items: *559
examples:
- default: &674
+ default: &671
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -81686,11 +81257,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
- - &563
+ - &560
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)"
@@ -81705,9 +81276,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: &660
+ default: &657
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -81820,11 +81391,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:
- - *444
- - *445
- - *563
- - *564
- - *565
+ - *441
+ - *442
+ - *560
+ - *561
+ - *562
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -81858,9 +81429,9 @@ paths:
type: integer
check_runs:
type: array
- items: *508
+ items: *505
examples:
- default: *566
+ default: *563
headers:
Link: *45
x-github:
@@ -81885,9 +81456,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:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -81895,7 +81466,7 @@ paths:
schema:
type: integer
example: 1
- - *564
+ - *561
- *17
- *19
responses:
@@ -81913,7 +81484,7 @@ paths:
type: integer
check_suites:
type: array
- items: *512
+ items: *509
examples:
default:
value:
@@ -82113,9 +81684,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:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- *17
- *19
responses:
@@ -82317,9 +81888,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- *17
- *19
responses:
@@ -82329,7 +81900,7 @@ paths:
application/json:
schema:
type: array
- items: &735
+ items: &732
title: Status
description: The status of a commit.
type: object
@@ -82410,7 +81981,7 @@ paths:
site_admin: false
headers:
Link: *45
- '301': *450
+ '301': *447
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82438,8 +82009,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -82472,11 +82043,11 @@ paths:
code_of_conduct:
anyOf:
- type: 'null'
- - *567
+ - *564
code_of_conduct_file:
anyOf:
- type: 'null'
- - &568
+ - &565
title: Community Health File
type: object
properties:
@@ -82496,19 +82067,19 @@ paths:
contributing:
anyOf:
- type: 'null'
- - *568
+ - *565
readme:
anyOf:
- type: 'null'
- - *568
+ - *565
issue_template:
anyOf:
- type: 'null'
- - *568
+ - *565
pull_request_template:
anyOf:
- type: 'null'
- - *568
+ - *565
required:
- code_of_conduct
- code_of_conduct_file
@@ -82637,8 +82208,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
- name: basehead
@@ -82686,8 +82257,8 @@ paths:
format: uri
examples:
- https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *558
- merge_base_commit: *558
+ base_commit: *555
+ merge_base_commit: *555
status:
type: string
enum:
@@ -82711,10 +82282,10 @@ paths:
- 6
commits:
type: array
- items: *558
+ items: *555
files:
type: array
- items: *569
+ items: *566
required:
- url
- html_url
@@ -83000,8 +82571,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -83154,7 +82725,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &570
+ response-if-content-is-a-file: &567
summary: Response if content is a file
value:
type: file
@@ -83291,7 +82862,7 @@ paths:
- size
- type
- url
- - &687
+ - &684
title: Content File
description: Content File
type: object
@@ -83509,7 +83080,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *570
+ response-if-content-is-a-file: *567
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -83578,7 +83149,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *27
- '302': *571
+ '302': *568
'304': *35
x-github:
githubCloudOnly: false
@@ -83601,8 +83172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -83697,7 +83268,7 @@ paths:
description: Response
content:
application/json:
- schema: &572
+ schema: &569
title: File Commit
description: File Commit
type: object
@@ -83853,7 +83424,7 @@ paths:
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
example-for-creating-a-file:
value:
@@ -83907,7 +83478,7 @@ paths:
schema:
oneOf:
- *3
- - &613
+ - &610
description: Repository rule violation was detected
type: object
properties:
@@ -83928,7 +83499,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &727
+ placeholder_id: &724
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -83960,8 +83531,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -84022,7 +83593,7 @@ paths:
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
default:
value:
@@ -84077,8 +83648,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -84202,8 +83773,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *321
- *322
- *323
@@ -84215,7 +83786,7 @@ paths:
schema:
type: string
- *325
- - *573
+ - *570
- *326
- *327
- *108
@@ -84236,7 +83807,7 @@ paths:
application/json:
schema:
type: array
- items: &577
+ items: &574
type: object
description: A Dependabot alert.
properties:
@@ -84286,7 +83857,7 @@ paths:
- direct
- transitive
-
- security_advisory: *574
+ security_advisory: *571
security_vulnerability: *127
url: *128
html_url: *129
@@ -84317,8 +83888,8 @@ paths:
dismissal.
maxLength: 280
fixed_at: *133
- auto_dismissed_at: *575
- dismissal_request: *576
+ auto_dismissed_at: *572
+ dismissal_request: *573
required:
- number
- state
@@ -84548,9 +84119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *444
- - *445
- - &578
+ - *441
+ - *442
+ - &575
name: alert_number
in: path
description: |-
@@ -84565,7 +84136,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -84678,9 +84249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *444
- - *445
- - *578
+ - *441
+ - *442
+ - *575
requestBody:
required: true
content:
@@ -84725,7 +84296,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -84854,8 +84425,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -84873,7 +84444,7 @@ paths:
type: integer
secrets:
type: array
- items: &581
+ items: &578
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -84927,16 +84498,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84956,15 +84527,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -84990,8 +84561,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -85044,8 +84615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -85068,8 +84639,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:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -85243,8 +84814,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -85504,8 +85075,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -85588,7 +85159,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &582
+ metadata: &579
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -85627,7 +85198,7 @@ paths:
examples:
- "/src/build/package-lock.json"
additionalProperties: false
- metadata: *582
+ metadata: *579
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -85641,7 +85212,7 @@ paths:
pattern: "^pkg"
examples:
- pkg:/npm/%40actions/http-client@1.0.11
- metadata: *582
+ metadata: *579
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -85774,8 +85345,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -85816,9 +85387,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: *584
+ default: *581
headers:
Link: *45
x-github:
@@ -85884,8 +85455,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -85967,7 +85538,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
simple-example:
summary: Simple example
@@ -86040,9 +85611,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *444
- - *445
- - &585
+ - *441
+ - *442
+ - &582
name: deployment_id
description: deployment_id parameter
in: path
@@ -86054,7 +85625,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -86119,9 +85690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
responses:
'204':
description: Response
@@ -86143,9 +85714,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
- *17
- *19
responses:
@@ -86155,7 +85726,7 @@ paths:
application/json:
schema:
type: array
- items: &586
+ items: &583
title: Deployment Status
description: The status of a deployment.
type: object
@@ -86319,9 +85890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
requestBody:
required: true
content:
@@ -86396,9 +85967,9 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *583
examples:
- default: &587
+ default: &584
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -86454,9 +86025,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
- name: status_id
in: path
required: true
@@ -86467,9 +86038,9 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *583
examples:
- default: *587
+ default: *584
'404': *6
x-github:
githubCloudOnly: false
@@ -86496,12 +86067,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
+ - *585
+ - *586
+ - *587
- *588
- - *589
- - *590
- - *591
- *17
- *19
responses:
@@ -86511,9 +86082,9 @@ paths:
application/json:
schema:
type: array
- items: *592
+ items: *589
examples:
- default: *593
+ default: *590
'404': *6
'403': *27
'500': *38
@@ -86537,8 +86108,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86550,7 +86121,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *592
+ schema: *589
examples:
default:
value:
@@ -86606,8 +86177,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86666,12 +86237,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
+ - *585
+ - *586
+ - *587
- *588
- - *589
- - *590
- - *591
- *17
- *19
responses:
@@ -86681,9 +86252,9 @@ paths:
application/json:
schema:
type: array
- items: *594
+ items: *591
examples:
- default: *595
+ default: *592
'404': *6
'403': *27
'500': *38
@@ -86707,8 +86278,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86720,7 +86291,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *594
+ schema: *591
examples:
default:
value:
@@ -86771,8 +86342,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86810,7 +86381,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *594
+ schema: *591
examples:
default:
value:
@@ -86861,8 +86432,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86933,8 +86504,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86967,8 +86538,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -86982,9 +86553,9 @@ paths:
application/json:
schema:
type: array
- items: *596
+ items: *593
examples:
- default: *597
+ default: *594
'404': *6
'403': *27
'500': *38
@@ -87009,8 +86580,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -87022,7 +86593,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *596
+ schema: *593
examples:
default:
value:
@@ -87080,8 +86651,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -87150,8 +86721,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -87208,8 +86779,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -87227,7 +86798,7 @@ paths:
- 5
environments:
type: array
- items: &599
+ items: &596
title: Environment
description: Details of a deployment environment
type: object
@@ -87289,7 +86860,7 @@ paths:
type: string
examples:
- wait_timer
- wait_timer: &601
+ wait_timer: &598
type: integer
description: The amount of time to delay a job after
the job is initially triggered. The time (in minutes)
@@ -87331,7 +86902,7 @@ paths:
items:
type: object
properties:
- type: *598
+ type: *595
reviewer:
anyOf:
- *4
@@ -87358,7 +86929,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &602
+ deployment_branch_policy: &599
type:
- object
- 'null'
@@ -87475,9 +87046,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *444
- - *445
- - &600
+ - *441
+ - *442
+ - &597
name: environment_name
in: path
required: true
@@ -87490,9 +87061,9 @@ paths:
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: &603
+ default: &600
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -87576,9 +87147,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: false
content:
@@ -87588,7 +87159,7 @@ paths:
- object
- 'null'
properties:
- wait_timer: *601
+ wait_timer: *598
prevent_self_review:
type: boolean
description: Whether or not a user who created the job is prevented
@@ -87607,14 +87178,14 @@ paths:
items:
type: object
properties:
- type: *598
+ type: *595
id:
type: integer
description: The id of the user or team who can review the
deployment
examples:
- 4532992
- deployment_branch_policy: *602
+ deployment_branch_policy: *599
additionalProperties: false
examples:
default:
@@ -87634,9 +87205,9 @@ paths:
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: *603
+ default: *600
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -87660,9 +87231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
responses:
'204':
description: Default response
@@ -87687,9 +87258,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *17
- *19
responses:
@@ -87708,7 +87279,7 @@ paths:
- 2
branch_policies:
type: array
- items: &604
+ items: &601
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -87769,9 +87340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: true
content:
@@ -87819,9 +87390,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- example-wildcard: &605
+ example-wildcard: &602
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -87863,10 +87434,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - &606
+ - *441
+ - *442
+ - *597
+ - &603
name: branch_policy_id
in: path
required: true
@@ -87878,9 +87449,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87899,10 +87470,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - *606
+ - *441
+ - *442
+ - *597
+ - *603
requestBody:
required: true
content:
@@ -87931,9 +87502,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87952,10 +87523,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - *606
+ - *441
+ - *442
+ - *597
+ - *603
responses:
'204':
description: Response
@@ -87980,9 +87551,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
responses:
'200':
description: List of deployment protection rules
@@ -87999,7 +87570,7 @@ paths:
- 10
custom_deployment_protection_rules:
type: array
- items: &607
+ items: &604
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -88021,7 +87592,7 @@ paths:
for the environment.
examples:
- true
- app: &608
+ app: &605
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -88124,9 +87695,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
requestBody:
content:
application/json:
@@ -88147,9 +87718,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: &609
+ default: &606
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -88184,9 +87755,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
- *19
- *17
responses:
@@ -88206,7 +87777,7 @@ paths:
- 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *608
+ items: *605
examples:
default:
value:
@@ -88241,10 +87812,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:
- - *444
- - *445
- - *600
- - &610
+ - *441
+ - *442
+ - *597
+ - &607
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -88256,9 +87827,9 @@ paths:
description: Response
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: *609
+ default: *606
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88279,10 +87850,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:
- - *600
- - *445
- - *444
- - *610
+ - *597
+ - *442
+ - *441
+ - *607
responses:
'204':
description: Response
@@ -88308,9 +87879,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *17
- *19
responses:
@@ -88328,9 +87899,9 @@ paths:
type: integer
secrets:
type: array
- items: *475
+ items: *472
examples:
- default: *476
+ default: *473
headers:
Link: *45
x-github:
@@ -88355,17 +87926,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88387,18 +87958,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
- default: *611
+ default: *608
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88420,9 +87991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
requestBody:
required: true
@@ -88480,9 +88051,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
responses:
'204':
@@ -88508,10 +88079,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *444
- - *445
- - *600
- - *462
+ - *441
+ - *442
+ - *597
+ - *459
- *19
responses:
'200':
@@ -88528,9 +88099,9 @@ paths:
type: integer
variables:
type: array
- items: *479
+ items: *476
examples:
- default: *480
+ default: *477
headers:
Link: *45
x-github:
@@ -88553,9 +88124,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: true
content:
@@ -88607,18 +88178,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *285
responses:
'200':
description: Response
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: *612
+ default: *609
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88639,10 +88210,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
- - *600
+ - *597
requestBody:
required: true
content:
@@ -88684,10 +88255,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
- - *600
+ - *597
responses:
'204':
description: Response
@@ -88709,8 +88280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -88778,8 +88349,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -88938,8 +88509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -88972,9 +88543,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
'400': *14
'422': *15
'403': *27
@@ -88995,8 +88566,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89056,7 +88627,7 @@ paths:
schema:
oneOf:
- *247
- - *613
+ - *610
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89081,8 +88652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: file_sha
in: path
required: true
@@ -89182,8 +88753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89292,7 +88863,7 @@ paths:
description: Response
content:
application/json:
- schema: &614
+ schema: &611
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -89519,15 +89090,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
responses:
'200':
description: Response
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -89583,9 +89154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *444
- - *445
- - &615
+ - *441
+ - *442
+ - &612
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.
@@ -89602,7 +89173,7 @@ paths:
application/json:
schema:
type: array
- items: &616
+ items: &613
title: Git Reference
description: Git references within a repository
type: object
@@ -89678,17 +89249,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
responses:
'200':
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: &617
+ default: &614
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -89717,8 +89288,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89747,9 +89318,9 @@ paths:
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: *617
+ default: *614
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -89775,9 +89346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
requestBody:
required: true
content:
@@ -89806,9 +89377,9 @@ paths:
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: *617
+ default: *614
'422': *15
'409': *116
x-github:
@@ -89826,9 +89397,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
responses:
'204':
description: Response
@@ -89883,8 +89454,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89951,7 +89522,7 @@ paths:
description: Response
content:
application/json:
- schema: &619
+ schema: &616
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -90007,7 +89578,7 @@ paths:
- sha
- type
- url
- verification: *618
+ verification: *615
required:
- sha
- url
@@ -90017,7 +89588,7 @@ paths:
- tag
- message
examples:
- default: &620
+ default: &617
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -90090,8 +89661,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tag_sha
in: path
required: true
@@ -90102,9 +89673,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *620
+ default: *617
'404': *6
'409': *116
x-github:
@@ -90128,8 +89699,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -90203,7 +89774,7 @@ paths:
description: Response
content:
application/json:
- schema: &621
+ schema: &618
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -90305,8 +89876,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -90329,7 +89900,7 @@ paths:
description: Response
content:
application/json:
- schema: *621
+ schema: *618
examples:
default-response:
summary: Default response
@@ -90388,8 +89959,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -90399,7 +89970,7 @@ paths:
application/json:
schema:
type: array
- items: &622
+ items: &619
title: Webhook
description: Webhooks for repositories.
type: object
@@ -90462,7 +90033,7 @@ paths:
format: uri
examples:
- https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &876
+ last_response: &871
title: Hook Response
type: object
properties:
@@ -90539,8 +90110,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -90593,9 +90164,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: &623
+ default: &620
value:
type: Repository
id: 12345678
@@ -90643,17 +90214,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'200':
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *623
+ default: *620
'404': *6
x-github:
githubCloudOnly: false
@@ -90673,8 +90244,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
requestBody:
required: true
@@ -90720,9 +90291,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *623
+ default: *620
'422': *15
'404': *6
x-github:
@@ -90743,8 +90314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90769,8 +90340,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'200':
@@ -90798,8 +90369,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
requestBody:
required: false
@@ -90844,8 +90415,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *17
- *336
@@ -90877,8 +90448,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *16
responses:
@@ -90907,8 +90478,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *16
responses:
@@ -90932,8 +90503,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90959,8 +90530,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90984,8 +90555,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response if immutable releases are enabled
@@ -91033,8 +90604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'409': *116
@@ -91054,8 +90625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'409': *116
@@ -91112,14 +90683,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &624
+ schema: &621
title: Import
description: A repository import from an external source.
type: object
@@ -91226,7 +90797,7 @@ paths:
- html_url
- authors_url
examples:
- default: &627
+ default: &624
value:
vcs: subversion
use_lfs: true
@@ -91242,7 +90813,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': &625
+ '503': &622
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -91271,8 +90842,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -91320,7 +90891,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
default:
value:
@@ -91345,7 +90916,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91373,8 +90944,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -91426,7 +90997,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
example-1:
summary: Example 1
@@ -91474,7 +91045,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': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91497,12 +91068,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91528,9 +91099,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *444
- - *445
- - &809
+ - *441
+ - *442
+ - &804
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -91544,7 +91115,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
title: Porter Author
description: Porter Author
type: object
@@ -91598,7 +91169,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': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91623,8 +91194,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: author_id
in: path
required: true
@@ -91654,7 +91225,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -91667,7 +91238,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91691,8 +91262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91733,7 +91304,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91761,8 +91332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -91789,11 +91360,11 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *627
+ default: *624
'422': *15
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91816,8 +91387,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91825,8 +91396,8 @@ paths:
application/json:
schema: *20
examples:
- default: *628
- '301': *450
+ default: *625
+ '301': *447
'404': *6
x-github:
githubCloudOnly: false
@@ -91846,8 +91417,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91860,7 +91431,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &630
+ default: &627
value:
limit: collaborators_only
origin: repository
@@ -91885,13 +91456,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *629
+ schema: *626
examples:
default:
summary: Example request body
@@ -91905,7 +91476,7 @@ paths:
application/json:
schema: *353
examples:
- default: *630
+ default: *627
'409':
description: Response
x-github:
@@ -91927,8 +91498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -91951,8 +91522,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -91962,9 +91533,9 @@ paths:
application/json:
schema:
type: array
- items: *631
+ items: *628
examples:
- default: &802
+ default: &797
value:
- id: 1
repository:
@@ -92095,8 +91666,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *357
requestBody:
required: false
@@ -92126,7 +91697,7 @@ paths:
description: Response
content:
application/json:
- schema: *631
+ schema: *628
examples:
default:
value:
@@ -92257,8 +91828,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *357
responses:
'204':
@@ -92290,8 +91861,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -92364,7 +91935,7 @@ paths:
type: array
items: *212
examples:
- default: &641
+ default: &638
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -92512,7 +92083,7 @@ paths:
state_reason: completed
headers:
Link: *45
- '301': *450
+ '301': *447
'422': *15
'404': *6
x-github:
@@ -92541,8 +92112,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -92634,7 +92205,7 @@ paths:
application/json:
schema: *212
examples:
- default: &638
+ default: &635
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -92790,7 +92361,7 @@ paths:
'422': *15
'503': *189
'404': *6
- '410': *632
+ '410': *629
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -92818,8 +92389,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *235
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -92840,9 +92411,9 @@ paths:
application/json:
schema:
type: array
- items: *633
+ items: *630
examples:
- default: &640
+ default: &637
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -92900,17 +92471,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: &634
+ default: &631
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -92964,8 +92535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -92988,9 +92559,9 @@ paths:
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: *634
+ default: *631
'422': *15
x-github:
githubCloudOnly: false
@@ -93008,8 +92579,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -93030,8 +92601,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -93058,9 +92629,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -93081,8 +92652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -93115,16 +92686,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -93146,10 +92717,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - *636
+ - *633
responses:
'204':
description: Response
@@ -93169,8 +92740,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -93180,7 +92751,7 @@ paths:
application/json:
schema:
type: array
- items: &637
+ items: &634
title: Issue Event
description: Issue Event
type: object
@@ -93519,8 +93090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: event_id
in: path
required: true
@@ -93531,7 +93102,7 @@ paths:
description: Response
content:
application/json:
- schema: *637
+ schema: *634
examples:
default:
value:
@@ -93723,7 +93294,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *632
+ '410': *629
'403': *27
x-github:
githubCloudOnly: false
@@ -93757,9 +93328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *444
- - *445
- - &639
+ - *441
+ - *442
+ - &636
name: issue_number
description: The number that identifies the issue.
in: path
@@ -93773,10 +93344,10 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'304': *35
x-github:
githubCloudOnly: false
@@ -93801,9 +93372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -93924,13 +93495,13 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
'422': *15
'503': *189
'403': *27
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93948,9 +93519,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -93978,7 +93549,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93994,9 +93565,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
content:
application/json:
@@ -94023,7 +93594,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94045,9 +93616,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: assignee
in: path
required: true
@@ -94087,9 +93658,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *218
- *17
- *19
@@ -94100,13 +93671,13 @@ paths:
application/json:
schema:
type: array
- items: *633
+ items: *630
examples:
- default: *640
+ default: *637
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94135,9 +93706,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -94159,16 +93730,16 @@ paths:
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: *634
+ default: *631
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -94196,9 +93767,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94210,12 +93781,12 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94243,9 +93814,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -94269,15 +93840,15 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *450
+ '301': *447
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -94308,9 +93879,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -94324,13 +93895,13 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'400': *14
'401': *23
'403': *27
'404': *6
- '410': *632
+ '410': *629
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -94356,9 +93927,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94370,12 +93941,12 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94392,9 +93963,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94408,7 +93979,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &643
+ - &640
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -94457,7 +94028,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &644
+ - &641
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -94585,7 +94156,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &645
+ - &642
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -94631,7 +94202,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &646
+ - &643
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -94677,7 +94248,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &647
+ - &644
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -94726,7 +94297,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &648
+ - &645
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -94768,7 +94339,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &649
+ - &646
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -94810,7 +94381,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &650
+ - &647
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -94866,7 +94437,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &651
+ - &648
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -94911,7 +94482,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &652
+ - &649
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -94972,7 +94543,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &653
+ - &650
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -95033,7 +94604,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &654
+ - &651
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -95094,7 +94665,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &655
+ - &652
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -95187,7 +94758,7 @@ paths:
color: red
headers:
Link: *45
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95204,9 +94775,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95218,7 +94789,7 @@ paths:
type: array
items: *211
examples:
- default: &642
+ default: &639
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -95236,9 +94807,9 @@ paths:
default: false
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95255,9 +94826,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95318,10 +94889,10 @@ paths:
type: array
items: *211
examples:
- default: *642
- '301': *450
+ default: *639
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'422': *15
x-github:
githubCloudOnly: false
@@ -95338,9 +94909,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95402,10 +94973,10 @@ paths:
type: array
items: *211
examples:
- default: *642
- '301': *450
+ default: *639
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'422': *15
x-github:
githubCloudOnly: false
@@ -95422,15 +94993,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'204':
description: Response
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95449,9 +95020,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: name
in: path
required: true
@@ -95475,9 +95046,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95497,9 +95068,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95528,7 +95099,7 @@ paths:
'204':
description: Response
'403': *27
- '410': *632
+ '410': *629
'404': *6
'422': *15
x-github:
@@ -95546,9 +95117,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'204':
description: Response
@@ -95578,9 +95149,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'200':
description: Response
@@ -95588,10 +95159,10 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95608,9 +95179,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- 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.
@@ -95636,13 +95207,13 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95660,9 +95231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95694,16 +95265,16 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -95725,10 +95296,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
- *636
+ - *633
responses:
'204':
description: Response
@@ -95757,9 +95328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95783,7 +95354,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -95816,9 +95387,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95830,11 +95401,11 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95862,9 +95433,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95893,14 +95464,14 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -95920,9 +95491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95955,7 +95526,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
'403': *27
'404': *6
'422': *7
@@ -95977,9 +95548,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95994,6 +95565,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *640
+ - *641
+ - *642
- *643
- *644
- *645
@@ -96004,9 +95578,6 @@ paths:
- *650
- *651
- *652
- - *653
- - *654
- - *655
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -96335,7 +95906,7 @@ paths:
type: string
comments:
type: array
- items: &676
+ items: &673
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -96573,7 +96144,7 @@ paths:
type: string
comments:
type: array
- items: *555
+ items: *552
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -96848,7 +96419,7 @@ paths:
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96865,8 +96436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -96876,7 +96447,7 @@ paths:
application/json:
schema:
type: array
- items: &656
+ items: &653
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -96944,8 +96515,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -96981,9 +96552,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: &657
+ default: &654
value:
id: 1
key: ssh-rsa AAA...
@@ -97017,9 +96588,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *444
- - *445
- - &658
+ - *441
+ - *442
+ - &655
name: key_id
description: The unique identifier of the key.
in: path
@@ -97031,9 +96602,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
'404': *6
x-github:
githubCloudOnly: false
@@ -97051,9 +96622,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *444
- - *445
- - *658
+ - *441
+ - *442
+ - *655
responses:
'204':
description: Response
@@ -97073,8 +96644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -97086,7 +96657,7 @@ paths:
type: array
items: *211
examples:
- default: *642
+ default: *639
headers:
Link: *45
'404': *6
@@ -97107,8 +96678,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97146,7 +96717,7 @@ paths:
application/json:
schema: *211
examples:
- default: &659
+ default: &656
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -97178,8 +96749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97192,7 +96763,7 @@ paths:
application/json:
schema: *211
examples:
- default: *659
+ default: *656
'404': *6
x-github:
githubCloudOnly: false
@@ -97209,8 +96780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97275,8 +96846,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97302,8 +96873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -97339,8 +96910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'202': *37
'403':
@@ -97368,8 +96939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -97395,9 +96966,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *444
- - *445
- - *530
+ - *441
+ - *442
+ - *527
responses:
'200':
description: Response
@@ -97544,8 +97115,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97610,8 +97181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97645,9 +97216,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *660
+ default: *657
'204':
description: Response when already merged
'404':
@@ -97672,8 +97243,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -97770,8 +97341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97813,7 +97384,7 @@ paths:
application/json:
schema: *392
examples:
- default: &661
+ default: &658
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -97872,9 +97443,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *444
- - *445
- - &662
+ - *441
+ - *442
+ - &659
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -97888,7 +97459,7 @@ paths:
application/json:
schema: *392
examples:
- default: *661
+ default: *658
'404': *6
x-github:
githubCloudOnly: false
@@ -97905,9 +97476,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
requestBody:
required: false
content:
@@ -97947,7 +97518,7 @@ paths:
application/json:
schema: *392
examples:
- default: *661
+ default: *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -97963,9 +97534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
responses:
'204':
description: Response
@@ -97986,9 +97557,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:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
- *17
- *19
responses:
@@ -98000,7 +97571,7 @@ paths:
type: array
items: *211
examples:
- default: *642
+ default: *639
headers:
Link: *45
x-github:
@@ -98019,12 +97590,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:
- - *444
- - *445
- - *663
- - *664
+ - *441
+ - *442
+ - *660
+ - *661
- *218
- - *665
+ - *662
- *17
- *19
responses:
@@ -98036,7 +97607,7 @@ paths:
type: array
items: *238
examples:
- default: *666
+ default: *663
headers:
Link: *45
x-github:
@@ -98060,8 +97631,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -98119,14 +97690,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &667
+ schema: &664
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -98270,7 +97841,7 @@ paths:
- custom_404
- public
examples:
- default: &668
+ default: &665
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -98311,8 +97882,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98367,9 +97938,9 @@ paths:
description: Response
content:
application/json:
- schema: *667
+ schema: *664
examples:
- default: *668
+ default: *665
'422': *15
'409': *116
x-github:
@@ -98392,8 +97963,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98501,8 +98072,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -98528,8 +98099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -98539,7 +98110,7 @@ paths:
application/json:
schema:
type: array
- items: &669
+ items: &666
title: Page Build
description: Page Build
type: object
@@ -98631,8 +98202,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -98679,16 +98250,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *669
+ schema: *666
examples:
- default: &670
+ default: &667
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -98736,8 +98307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: build_id
in: path
required: true
@@ -98748,9 +98319,9 @@ paths:
description: Response
content:
application/json:
- schema: *669
+ schema: *666
examples:
- default: *670
+ default: *667
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98770,8 +98341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98879,9 +98450,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:
- - *444
- - *445
- - &671
+ - *441
+ - *442
+ - &668
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -98939,9 +98510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *444
- - *445
- - *671
+ - *441
+ - *442
+ - *668
responses:
'204': *148
'404': *6
@@ -98968,8 +98539,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -99264,8 +98835,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Private vulnerability reporting status
@@ -99302,8 +98873,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'422': *14
@@ -99324,8 +98895,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'422': *14
@@ -99347,8 +98918,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -99358,7 +98929,7 @@ paths:
type: array
items: *149
examples:
- default: *672
+ default: *669
'403': *27
'404': *6
x-github:
@@ -99380,8 +98951,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -99397,7 +98968,7 @@ paths:
required:
- properties
examples:
- default: *673
+ default: *670
responses:
'204':
description: No Content when custom property values are successfully created
@@ -99435,8 +99006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -99496,9 +99067,9 @@ paths:
application/json:
schema:
type: array
- items: *562
+ items: *559
examples:
- default: *674
+ default: *671
headers:
Link: *45
'304': *35
@@ -99530,8 +99101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -99598,7 +99169,7 @@ paths:
description: Response
content:
application/json:
- schema: &678
+ schema: &675
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -99838,7 +99409,7 @@ paths:
- review_comment
- self
author_association: *213
- auto_merge: *675
+ auto_merge: *672
draft:
description: Indicates whether or not the pull request is a draft.
type: boolean
@@ -99940,7 +99511,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &679
+ default: &676
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -100467,8 +100038,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sort
in: query
required: false
@@ -100497,9 +100068,9 @@ paths:
application/json:
schema:
type: array
- items: *676
+ items: *673
examples:
- default: &681
+ default: &678
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -100576,17 +100147,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
- default: &677
+ default: &674
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -100661,8 +100232,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -100685,9 +100256,9 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
- default: *677
+ default: *674
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -100703,8 +100274,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -100726,8 +100297,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -100754,9 +100325,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -100777,8 +100348,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -100811,16 +100382,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -100842,10 +100413,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - *636
+ - *633
responses:
'204':
description: Response
@@ -100888,9 +100459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *444
- - *445
- - &680
+ - *441
+ - *442
+ - &677
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -100903,9 +100474,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'304': *35
'404': *6
'406':
@@ -100940,9 +100511,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -100984,9 +100555,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'422': *15
'403': *27
x-github:
@@ -101008,9 +100579,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -101073,7 +100644,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -101081,7 +100652,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -101111,9 +100682,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *235
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -101134,9 +100705,9 @@ paths:
application/json:
schema:
type: array
- items: *676
+ items: *673
examples:
- default: *681
+ default: *678
headers:
Link: *45
x-github:
@@ -101169,9 +100740,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -101277,7 +100848,7 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
example-for-a-multi-line-comment:
value:
@@ -101365,9 +100936,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *227
requestBody:
required: true
@@ -101390,7 +100961,7 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
default:
value:
@@ -101476,9 +101047,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -101488,9 +101059,9 @@ paths:
application/json:
schema:
type: array
- items: *558
+ items: *555
examples:
- default: *682
+ default: *679
headers:
Link: *45
x-github:
@@ -101520,9 +101091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -101532,7 +101103,7 @@ paths:
application/json:
schema:
type: array
- items: *569
+ items: *566
examples:
default:
value:
@@ -101570,9 +101141,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
responses:
'204':
description: Response if pull request has been merged
@@ -101595,9 +101166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -101709,9 +101280,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
responses:
'200':
description: Response
@@ -101786,9 +101357,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -101825,7 +101396,7 @@ paths:
description: Response
content:
application/json:
- schema: *562
+ schema: *559
examples:
default:
value:
@@ -102361,9 +101932,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -102397,7 +101968,7 @@ paths:
description: Response
content:
application/json:
- schema: *562
+ schema: *559
examples:
default:
value:
@@ -102902,9 +102473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -102914,7 +102485,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &680
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -103070,9 +102641,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -103162,9 +102733,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &685
+ default: &682
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -103227,10 +102798,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:
- - *444
- - *445
- - *680
- - &684
+ - *441
+ - *442
+ - *677
+ - &681
name: review_id
description: The unique identifier of the review.
in: path
@@ -103242,9 +102813,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &686
+ default: &683
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -103303,10 +102874,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103329,7 +102900,7 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
default:
value:
@@ -103391,18 +102962,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
responses:
'200':
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *685
+ default: *682
'422': *7
'404': *6
x-github:
@@ -103429,10 +103000,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
- *17
- *19
responses:
@@ -103690,10 +103261,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103722,7 +103293,7 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
default:
value:
@@ -103785,10 +103356,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103823,9 +103394,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *686
+ default: *683
'404': *6
'422': *7
'403': *27
@@ -103847,9 +103418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -103913,8 +103484,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -103927,9 +103498,9 @@ paths:
description: Response
content:
application/json:
- schema: *687
+ schema: *684
examples:
- default: &688
+ default: &685
value:
type: file
encoding: base64
@@ -103971,8 +103542,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:
- - *444
- - *445
+ - *441
+ - *442
- name: dir
description: The alternate path to look for a README file
in: path
@@ -103992,9 +103563,9 @@ paths:
description: Response
content:
application/json:
- schema: *687
+ schema: *684
examples:
- default: *688
+ default: *685
'404': *6
'422': *15
x-github:
@@ -104016,8 +103587,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -104027,7 +103598,7 @@ paths:
application/json:
schema:
type: array
- items: *689
+ items: *686
examples:
default:
value:
@@ -104121,8 +103692,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -104198,9 +103769,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: &693
+ default: &690
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -104305,9 +103876,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *444
- - *445
- - &691
+ - *441
+ - *442
+ - &688
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -104319,9 +103890,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: &692
+ default: &689
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
@@ -104356,7 +103927,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *571
+ '302': *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104372,9 +103943,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *444
- - *445
- - *691
+ - *441
+ - *442
+ - *688
requestBody:
required: false
content:
@@ -104403,9 +103974,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: *692
+ default: *689
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104421,9 +103992,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *444
- - *445
- - *691
+ - *441
+ - *442
+ - *688
responses:
'204':
description: Response
@@ -104447,8 +104018,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -104534,16 +104105,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104560,8 +104131,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tag
description: tag parameter
in: path
@@ -104574,9 +104145,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'404': *6
x-github:
githubCloudOnly: false
@@ -104598,9 +104169,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *444
- - *445
- - &694
+ - *441
+ - *442
+ - &691
name: release_id
description: The unique identifier of the release.
in: path
@@ -104614,9 +104185,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: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'401':
description: Unauthorized
x-github:
@@ -104634,9 +104205,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
requestBody:
required: false
content:
@@ -104700,9 +104271,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -104723,9 +104294,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
responses:
'204':
description: Response
@@ -104745,9 +104316,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- *17
- *19
responses:
@@ -104757,7 +104328,7 @@ paths:
application/json:
schema:
type: array
- items: *690
+ items: *687
examples:
default:
value:
@@ -104839,9 +104410,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:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- name: name
in: query
required: true
@@ -104867,7 +104438,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *690
+ schema: *687
examples:
response-for-successful-upload:
value:
@@ -104922,9 +104493,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- 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.
@@ -104948,9 +104519,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -104971,9 +104542,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
requestBody:
required: true
content:
@@ -105003,16 +104574,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -105034,10 +104605,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *444
- - *445
- - *694
- - *636
+ - *441
+ - *442
+ - *691
+ - *633
responses:
'204':
description: Response
@@ -105061,9 +104632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
- *17
- *19
responses:
@@ -105080,7 +104651,7 @@ paths:
oneOf:
- allOf:
- *163
- - &695
+ - &692
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -105101,67 +104672,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *164
- - *695
+ - *692
- allOf:
- *165
- - *695
+ - *692
- allOf:
- *166
- - *695
+ - *692
- allOf:
- - *696
- - *695
+ - *693
+ - *692
- allOf:
- *167
- - *695
+ - *692
- allOf:
- *168
- - *695
+ - *692
- allOf:
- *169
- - *695
+ - *692
- allOf:
- *170
- - *695
+ - *692
- allOf:
- *171
- - *695
+ - *692
- allOf:
- *172
- - *695
+ - *692
- allOf:
- *173
- - *695
+ - *692
- allOf:
- *174
- - *695
+ - *692
- allOf:
- *175
- - *695
+ - *692
- allOf:
- *176
- - *695
+ - *692
- allOf:
- *177
- - *695
+ - *692
- allOf:
- *178
- - *695
+ - *692
- allOf:
- *179
- - *695
+ - *692
- allOf:
- *180
- - *695
+ - *692
- allOf:
- *181
- - *695
+ - *692
- allOf:
- *182
- - *695
+ - *692
- allOf:
- *183
- - *695
+ - *692
examples:
default:
value:
@@ -105200,8 +104771,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- name: includes_parents
@@ -105212,7 +104783,7 @@ paths:
schema:
type: boolean
default: true
- - *697
+ - *694
responses:
'200':
description: Response
@@ -105267,8 +104838,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
description: Request body
required: true
@@ -105297,7 +104868,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *698
+ items: *695
required:
- name
- enforcement
@@ -105330,7 +104901,7 @@ paths:
application/json:
schema: *184
examples:
- default: &707
+ default: &704
value:
id: 42
name: super cool ruleset
@@ -105377,12 +104948,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *444
- - *445
- - *699
+ - *441
+ - *442
+ - *696
- *103
- - *700
- - *701
+ - *697
+ - *698
- *17
- *19
responses:
@@ -105390,9 +104961,9 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: *703
+ default: *700
'404': *6
'500': *38
x-github:
@@ -105413,17 +104984,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *444
- - *445
- - *704
+ - *441
+ - *442
+ - *701
responses:
'200':
description: Response
content:
application/json:
- schema: *705
+ schema: *702
examples:
- default: *706
+ default: *703
'404': *6
'500': *38
x-github:
@@ -105451,8 +105022,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105474,7 +105045,7 @@ paths:
application/json:
schema: *184
examples:
- default: *707
+ default: *704
'404': *6
'500': *38
put:
@@ -105492,8 +105063,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105527,7 +105098,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *698
+ items: *695
examples:
default:
value:
@@ -105557,7 +105128,7 @@ paths:
application/json:
schema: *184
examples:
- default: *707
+ default: *704
'404': *6
'500': *38
delete:
@@ -105575,8 +105146,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105599,8 +105170,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- name: ruleset_id
@@ -105637,8 +105208,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105711,8 +105282,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:
- - *444
- - *445
+ - *441
+ - *442
- *410
- *411
- *412
@@ -105721,8 +105292,8 @@ paths:
- *108
- *19
- *17
- - *708
- - *709
+ - *705
+ - *706
- *415
- *416
- *417
@@ -105734,7 +105305,7 @@ paths:
application/json:
schema:
type: array
- items: &713
+ items: &710
type: object
properties:
number: *123
@@ -105750,8 +105321,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *710
- resolution: *711
+ state: *707
+ resolution: *708
resolved_at:
type:
- string
@@ -105845,7 +105416,7 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - *712
+ - *709
has_more_locations:
type: boolean
description: A boolean value representing whether or not the
@@ -105990,16 +105561,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *418
responses:
'200':
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
default:
value:
@@ -106053,9 +105624,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: true
content:
@@ -106063,8 +105634,8 @@ paths:
schema:
type: object
properties:
- state: *710
- resolution: *711
+ state: *707
+ resolution: *708
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -106100,7 +105671,7 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
default:
value:
@@ -106195,9 +105766,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *19
- *17
responses:
@@ -106208,7 +105779,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &896
+ items: &891
type: object
properties:
type:
@@ -106235,6 +105806,9 @@ paths:
- commit
details:
oneOf:
+ - *711
+ - *712
+ - *713
- *714
- *715
- *716
@@ -106245,9 +105819,6 @@ paths:
- *721
- *722
- *723
- - *724
- - *725
- - *726
examples:
default:
value:
@@ -106333,8 +105904,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -106342,14 +105913,14 @@ paths:
schema:
type: object
properties:
- reason: &728
+ reason: &725
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *727
+ placeholder_id: *724
required:
- reason
- placeholder_id
@@ -106366,7 +105937,7 @@ paths:
schema:
type: object
properties:
- reason: *728
+ reason: *725
expire_at:
type:
- string
@@ -106413,8 +105984,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -106429,7 +106000,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &729
+ items: &726
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -106457,15 +106028,15 @@ paths:
the scan is pending
pattern_update_scans:
type: array
- items: *729
+ items: *726
backfill_scans:
type: array
- items: *729
+ items: *726
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *729
+ - *726
- type: object
properties:
pattern_name:
@@ -106535,8 +106106,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *108
- name: sort
description: The property to sort the results by.
@@ -106580,9 +106151,9 @@ paths:
application/json:
schema:
type: array
- items: *730
+ items: *727
examples:
- default: *731
+ default: *728
'400': *14
'404': *6
x-github:
@@ -106605,8 +106176,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -106776,9 +106347,9 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: &733
+ default: &730
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -107011,8 +106582,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -107125,7 +106696,7 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
default:
value:
@@ -107272,17 +106843,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'200':
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: *733
+ default: *730
'403': *27
'404': *6
x-github:
@@ -107306,9 +106877,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
requestBody:
required: true
content:
@@ -107479,10 +107050,10 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: *733
- add_credit: *733
+ default: *730
+ add_credit: *730
'403': *27
'404': *6
'422':
@@ -107520,9 +107091,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'202': *37
'400': *14
@@ -107549,17 +107120,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'202':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
'400': *14
'422': *15
'403': *27
@@ -107585,8 +107156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -107682,8 +107253,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -107692,7 +107263,7 @@ paths:
application/json:
schema:
type: array
- items: &734
+ items: &731
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -107725,8 +107296,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -107804,8 +107375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -107899,8 +107470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -108054,8 +107625,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -108065,7 +107636,7 @@ paths:
application/json:
schema:
type: array
- items: *734
+ items: *731
examples:
default:
value:
@@ -108098,8 +107669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
in: path
required: true
@@ -108155,7 +107726,7 @@ paths:
description: Response
content:
application/json:
- schema: *735
+ schema: *732
examples:
default:
value:
@@ -108209,8 +107780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108242,14 +107813,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &736
+ schema: &733
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -108322,8 +107893,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -108349,7 +107920,7 @@ paths:
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -108376,8 +107947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -108397,8 +107968,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108480,8 +108051,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -108489,7 +108060,7 @@ paths:
application/json:
schema:
type: array
- items: &737
+ items: &734
title: Tag protection
description: Tag protection
type: object
@@ -108546,8 +108117,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -108570,7 +108141,7 @@ paths:
description: Response
content:
application/json:
- schema: *737
+ schema: *734
examples:
default:
value:
@@ -108601,8 +108172,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:
- - *444
- - *445
+ - *441
+ - *442
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -108639,8 +108210,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
in: path
required: true
@@ -108676,8 +108247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108709,8 +108280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
responses:
@@ -108718,7 +108289,7 @@ paths:
description: Response
content:
application/json:
- schema: &738
+ schema: &735
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -108730,7 +108301,7 @@ paths:
required:
- names
examples:
- default: &739
+ default: &736
value:
names:
- octocat
@@ -108753,8 +108324,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -108785,9 +108356,9 @@ paths:
description: Response
content:
application/json:
- schema: *738
+ schema: *735
examples:
- default: *739
+ default: *736
'404': *6
'422': *7
x-github:
@@ -108808,9 +108379,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *444
- - *445
- - &740
+ - *441
+ - *442
+ - &737
name: per
description: The time frame to display results for.
in: query
@@ -108841,7 +108412,7 @@ paths:
- 128
clones:
type: array
- items: &741
+ items: &738
title: Traffic
type: object
properties:
@@ -108929,8 +108500,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -109025,8 +108596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -109090,9 +108661,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *444
- - *445
- - *740
+ - *441
+ - *442
+ - *737
responses:
'200':
description: Response
@@ -109113,7 +108684,7 @@ paths:
- 3782
views:
type: array
- items: *741
+ items: *738
required:
- uniques
- count
@@ -109191,8 +108762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -109466,8 +109037,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -109490,8 +109061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -109513,8 +109084,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -109540,8 +109111,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
in: path
required: true
@@ -109633,9 +109204,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -109786,7 +109357,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &749
+ - &746
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -109796,7 +109367,7 @@ paths:
type: string
examples:
- members
- - &754
+ - &751
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -109808,7 +109379,7 @@ paths:
format: int32
examples:
- 1
- - &755
+ - &752
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -109852,7 +109423,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &744
+ items: &741
allOf:
- type: object
required:
@@ -109934,7 +109505,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: &756
+ meta: &753
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -109999,30 +109570,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &745
+ '400': &742
description: Bad request
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '401': *743
- '403': &746
+ schema: *739
+ '401': *740
+ '403': &743
description: Permission denied
- '429': &747
+ '429': &744
description: Too many requests
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '500': &748
+ schema: *739
+ '500': &745
description: Internal server error
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
+ schema: *739
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110046,7 +109617,7 @@ paths:
required: true
content:
application/json:
- schema: &752
+ schema: &749
type: object
required:
- schemas
@@ -110110,9 +109681,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- group: &750
+ group: &747
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -110131,13 +109702,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': *745
- '401': *743
- '403': *746
- '409': &753
+ '400': *742
+ '401': *740
+ '403': *743
+ '409': &750
description: Duplicate record detected
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110154,7 +109725,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:
- - &751
+ - &748
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -110163,22 +109734,22 @@ paths:
type: string
examples:
- 7fce0092-d52e-4f76-b727-3955bd72c939
- - *749
+ - *746
- *39
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- default: *750
- '400': *745
- '401': *743
- '403': *746
+ default: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110197,13 +109768,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:
- - *751
+ - *748
- *39
requestBody:
required: true
content:
application/json:
- schema: *752
+ schema: *749
examples:
group:
summary: Group
@@ -110229,17 +109800,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- group: *750
- groupWithMembers: *750
- '400': *745
- '401': *743
- '403': *746
+ group: *747
+ groupWithMembers: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110263,13 +109834,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:
- - *751
+ - *748
- *39
requestBody:
required: true
content:
application/json:
- schema: &763
+ schema: &760
type: object
required:
- Operations
@@ -110329,17 +109900,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- updateGroup: *750
- addMembers: *750
- '400': *745
- '401': *743
- '403': *746
+ updateGroup: *747
+ addMembers: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110355,17 +109926,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:
- - *751
+ - *748
- *39
responses:
'204':
description: Group was deleted, no content
- '400': *745
- '401': *743
- '403': *746
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110399,8 +109970,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *754
- - *755
+ - *751
+ - *752
- *39
responses:
'200':
@@ -110434,7 +110005,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &758
+ items: &755
allOf:
- type: object
required:
@@ -110526,7 +110097,7 @@ paths:
address.
examples:
- true
- roles: &757
+ roles: &754
type: array
description: The roles assigned to the user.
items:
@@ -110585,7 +110156,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *756
+ meta: *753
startIndex:
type: integer
description: A starting index for the returned page
@@ -110624,11 +110195,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *745
- '401': *743
- '403': *746
- '429': *747
- '500': *748
+ '400': *742
+ '401': *740
+ '403': *743
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110652,7 +110223,7 @@ paths:
required: true
content:
application/json:
- schema: &761
+ schema: &758
type: object
required:
- schemas
@@ -110745,9 +110316,9 @@ paths:
description: Whether this email address is the primary address.
examples:
- true
- roles: *757
+ roles: *754
examples:
- user: &762
+ user: &759
summary: User
value:
schemas:
@@ -110794,9 +110365,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- user: &759
+ user: &756
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -110822,13 +110393,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: *759
- '400': *745
- '401': *743
- '403': *746
- '409': *753
- '429': *747
- '500': *748
+ enterpriseOwner: *756
+ '400': *742
+ '401': *740
+ '403': *743
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110845,7 +110416,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:
- - &760
+ - &757
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -110858,15 +110429,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- default: *759
- '400': *745
- '401': *743
- '403': *746
+ default: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110888,30 +110459,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:
- - *760
+ - *757
- *39
requestBody:
required: true
content:
application/json:
- schema: *761
+ schema: *758
examples:
- user: *762
+ user: *759
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- user: *759
- '400': *745
- '401': *743
- '403': *746
+ user: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110946,13 +110517,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:
- - *760
+ - *757
- *39
requestBody:
required: true
content:
application/json:
- schema: *763
+ schema: *760
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -110992,18 +110563,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- userMultiValuedProperties: *759
- userSingleValuedProperties: *759
- disableUser: *759
- '400': *745
- '401': *743
- '403': *746
+ userMultiValuedProperties: *756
+ userSingleValuedProperties: *756
+ disableUser: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -111023,17 +110594,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:
- - *760
+ - *757
- *39
responses:
'204':
description: User was deleted, no content
- '400': *745
- '401': *743
- '403': *746
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -111124,7 +110695,7 @@ paths:
- 1
Resources:
type: array
- items: &764
+ items: &761
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -111371,22 +110942,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *35
- '404': &765
+ '404': &762
description: Resource not found
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '403': &766
+ schema: *739
+ '403': &763
description: Forbidden
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '400': *745
- '429': *747
+ schema: *739
+ '400': *742
+ '429': *744
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -111412,9 +110983,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: &767
+ default: &764
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -111437,17 +111008,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *35
- '404': *765
- '403': *766
- '500': *748
+ '404': *762
+ '403': *763
+ '500': *745
'409':
description: Conflict
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '400': *745
+ schema: *739
+ '400': *742
requestBody:
required: true
content:
@@ -111547,17 +111118,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
- '404': *765
- '403': *766
+ default: *764
+ '404': *762
+ '403': *763
'304': *35
x-github:
githubCloudOnly: true
@@ -111581,18 +111152,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
+ default: *764
'304': *35
- '404': *765
- '403': *766
+ '404': *762
+ '403': *763
requestBody:
required: true
content:
@@ -111707,19 +111278,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
+ default: *764
'304': *35
- '404': *765
- '403': *766
- '400': *745
+ '404': *762
+ '403': *763
+ '400': *742
'429':
description: Response
content:
@@ -111815,12 +111386,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *85
- - *760
+ - *757
responses:
'204':
description: Response
- '404': *765
- '403': *766
+ '404': *762
+ '403': *763
'304': *35
x-github:
githubCloudOnly: true
@@ -111954,7 +111525,7 @@ paths:
examples:
- 73..77
- 77..78
- text_matches: &768
+ text_matches: &765
title: Search Result Text Matches
type: array
items:
@@ -112118,7 +111689,7 @@ paths:
enum:
- author-date
- committer-date
- - &769
+ - &766
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
@@ -112187,7 +111758,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
comment_count:
type: integer
message:
@@ -112206,7 +111777,7 @@ paths:
url:
type: string
format: uri
- verification: *618
+ verification: *615
required:
- author
- committer
@@ -112221,7 +111792,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
parents:
type: array
items:
@@ -112238,7 +111809,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *768
+ text_matches: *765
required:
- sha
- node_id
@@ -112431,7 +112002,7 @@ paths:
- interactions
- created
- updated
- - *769
+ - *766
- *17
- *19
- name: advanced_search
@@ -112528,11 +112099,11 @@ paths:
type:
- string
- 'null'
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
type: string
state_reason:
@@ -112560,7 +112131,7 @@ paths:
- string
- 'null'
format: date-time
- text_matches: *768
+ text_matches: *765
pull_request:
type: object
properties:
@@ -112783,7 +112354,7 @@ paths:
enum:
- created
- updated
- - *769
+ - *766
- *17
- *19
responses:
@@ -112828,7 +112399,7 @@ paths:
- 'null'
score:
type: number
- text_matches: *768
+ text_matches: *765
required:
- id
- node_id
@@ -112914,7 +112485,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *769
+ - *766
- *17
- *19
responses:
@@ -113151,7 +112722,7 @@ paths:
- admin
- pull
- push
- text_matches: *768
+ text_matches: *765
temp_clone_token:
type: string
allow_merge_commit:
@@ -113460,7 +113031,7 @@ paths:
- string
- 'null'
format: uri
- text_matches: *768
+ text_matches: *765
related:
type:
- array
@@ -113655,7 +113226,7 @@ paths:
- followers
- repositories
- joined
- - *769
+ - *766
- *17
- *19
responses:
@@ -113765,7 +113336,7 @@ paths:
type:
- boolean
- 'null'
- text_matches: *768
+ text_matches: *765
blog:
type:
- string
@@ -113847,7 +113418,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &773
+ - &770
name: team_id
description: The unique identifier of the team.
in: path
@@ -113888,7 +113459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -113989,7 +113560,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *773
+ - *770
responses:
'204':
description: Response
@@ -114020,7 +113591,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
parameters:
- - *773
+ - *770
- *108
- *17
- *19
@@ -114033,7 +113604,7 @@ paths:
type: array
items: *433
examples:
- default: *774
+ default: *771
headers:
Link: *45
x-github:
@@ -114062,7 +113633,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -114125,7 +113696,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
responses:
'200':
@@ -114159,7 +113730,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
requestBody:
required: false
@@ -114185,7 +113756,7 @@ paths:
application/json:
schema: *433
examples:
- default: *775
+ default: *772
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -114210,7 +113781,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
responses:
'204':
@@ -114223,218 +113794,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:
- - *773
- - *435
- - *108
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *436
- examples:
- default: *776
- headers:
- Link: *45
- 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:
- - *773
- - *435
- 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: *436
- examples:
- default: *437
- 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:
- - *773
- - *435
- - *438
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *436
- examples:
- default: *437
- 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:
- - *773
- - *435
- - *438
- 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: *436
- examples:
- default: *777
- 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:
- - *773
- - *435
- - *438
- 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)
@@ -114450,7 +113809,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -114488,7 +113847,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *773
+ - *770
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -114539,7 +113898,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114576,7 +113935,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114616,7 +113975,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114653,16 +114012,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:
- - *773
+ - *770
- *136
responses:
'200':
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-user-is-a-team-maintainer: *778
+ response-if-user-is-a-team-maintainer: *773
'404': *6
x-github:
githubCloudOnly: false
@@ -114695,7 +114054,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:
- - *773
+ - *770
- *136
requestBody:
required: false
@@ -114721,9 +114080,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-users-membership-with-team-is-now-pending: *779
+ response-if-users-membership-with-team-is-now-pending: *774
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -114757,7 +114116,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:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114785,7 +114144,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -114827,15 +114186,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *780
+ schema: *775
examples:
alternative-response-with-extra-repository-information:
value:
@@ -114986,9 +114345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -115038,9 +114397,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -115069,15 +114428,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *773
+ - *770
responses:
'200':
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
- default: *447
+ default: *444
'403': *27
'404': *6
x-github:
@@ -115104,7 +114463,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -115165,7 +114524,7 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -115196,7 +114555,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -115208,7 +114567,7 @@ paths:
type: array
items: *301
examples:
- response-if-child-teams-exist: *781
+ response-if-child-teams-exist: *776
headers:
Link: *45
'404': *6
@@ -115241,7 +114600,7 @@ paths:
application/json:
schema:
oneOf:
- - &783
+ - &778
title: Private User
description: Private User
type: object
@@ -115491,7 +114850,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *782
+ - *777
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -115651,7 +115010,7 @@ paths:
description: Response
content:
application/json:
- schema: *783
+ schema: *778
examples:
default:
value:
@@ -115997,7 +115356,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -116005,7 +115364,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -116049,7 +115408,7 @@ paths:
type: integer
secrets:
type: array
- items: &784
+ items: &779
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -116091,7 +115450,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *549
+ default: *546
headers:
Link: *45
x-github:
@@ -116169,7 +115528,7 @@ paths:
description: Response
content:
application/json:
- schema: *784
+ schema: *779
examples:
default:
value:
@@ -116315,7 +115674,7 @@ paths:
type: array
items: *272
examples:
- default: *785
+ default: *780
'401': *23
'403': *27
'404': *6
@@ -116467,7 +115826,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'304': *35
'500': *38
'401': *23
@@ -116525,7 +115884,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -116582,7 +115941,7 @@ paths:
description: Response
content:
application/json:
- schema: &786
+ schema: &781
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -116635,7 +115994,7 @@ paths:
examples:
- https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &787
+ default: &782
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -116680,9 +116039,9 @@ paths:
description: Response
content:
application/json:
- schema: *786
+ schema: *781
examples:
- default: *787
+ default: *782
'404': *6
x-github:
githubCloudOnly: false
@@ -116719,9 +116078,9 @@ paths:
type: integer
machines:
type: array
- items: *548
+ items: *545
examples:
- default: *788
+ default: *783
'304': *35
'500': *38
'401': *23
@@ -116806,11 +116165,11 @@ paths:
- 26a7c758-7299-4a73-b978-5a92a7ae98a0
owner: *4
billable_owner: *4
- repository: *449
+ repository: *446
machine:
anyOf:
- type: 'null'
- - *548
+ - *545
devcontainer_path:
description: Path to devcontainer.json from repo root used to
create Codespace.
@@ -117615,7 +116974,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'304': *35
'500': *38
'400': *14
@@ -117655,7 +117014,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'500': *38
'401': *23
'403': *27
@@ -117687,7 +117046,7 @@ paths:
type: array
items: *373
examples:
- default: &799
+ default: &794
value:
- id: 197
name: hello_docker
@@ -117788,7 +117147,7 @@ paths:
application/json:
schema:
type: array
- items: &789
+ items: &784
title: Email
description: Email
type: object
@@ -117858,9 +117217,9 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
- default: &801
+ default: &796
value:
- email: octocat@github.com
verified: true
@@ -117937,7 +117296,7 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
default:
value:
@@ -118195,7 +117554,7 @@ paths:
application/json:
schema:
type: array
- items: &790
+ items: &785
title: GPG Key
description: A unique encryption key
type: object
@@ -118340,7 +117699,7 @@ paths:
- subkeys
- revoked
examples:
- default: &815
+ default: &810
value:
- id: 3
name: Octocat's GPG Key
@@ -118425,9 +117784,9 @@ paths:
description: Response
content:
application/json:
- schema: *790
+ schema: *785
examples:
- default: &791
+ default: &786
value:
id: 3
name: Octocat's GPG Key
@@ -118484,7 +117843,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &792
+ - &787
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -118496,9 +117855,9 @@ paths:
description: Response
content:
application/json:
- schema: *790
+ schema: *785
examples:
- default: *791
+ default: *786
'404': *6
'304': *35
'403': *27
@@ -118521,7 +117880,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *792
+ - *787
responses:
'204':
description: Response
@@ -118826,7 +118185,7 @@ paths:
required: true
content:
application/json:
- schema: *629
+ schema: *626
examples:
default:
value:
@@ -118976,7 +118335,7 @@ paths:
application/json:
schema:
type: array
- items: &793
+ items: &788
title: Key
description: Key
type: object
@@ -119079,9 +118438,9 @@ paths:
description: Response
content:
application/json:
- schema: *793
+ schema: *788
examples:
- default: &794
+ default: &789
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -119114,15 +118473,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *658
+ - *655
responses:
'200':
description: Response
content:
application/json:
- schema: *793
+ schema: *788
examples:
- default: *794
+ default: *789
'404': *6
'304': *35
'403': *27
@@ -119145,7 +118504,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *658
+ - *655
responses:
'204':
description: Response
@@ -119178,7 +118537,7 @@ paths:
application/json:
schema:
type: array
- items: &795
+ items: &790
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -119257,7 +118616,7 @@ paths:
- account
- plan
examples:
- default: &796
+ default: &791
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -119319,9 +118678,9 @@ paths:
application/json:
schema:
type: array
- items: *795
+ items: *790
examples:
- default: *796
+ default: *791
headers:
Link: *45
'304': *35
@@ -120339,7 +119698,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *369
- - *797
+ - *792
responses:
'204':
description: Response
@@ -120454,7 +119813,7 @@ paths:
- docker
- nuget
- container
- - *798
+ - *793
- *19
- *17
responses:
@@ -120466,8 +119825,8 @@ paths:
type: array
items: *373
examples:
- default: *799
- '400': *800
+ default: *794
+ '400': *795
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120496,7 +119855,7 @@ paths:
application/json:
schema: *373
examples:
- default: &816
+ default: &811
value:
id: 40201
name: octo-name
@@ -120858,9 +120217,9 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
- default: *801
+ default: *796
headers:
Link: *45
'304': *35
@@ -120973,7 +120332,7 @@ paths:
type: array
items: *76
examples:
- default: &808
+ default: &803
summary: Default response
value:
- id: 1296269
@@ -121291,9 +120650,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -121331,9 +120690,9 @@ paths:
application/json:
schema:
type: array
- items: *631
+ items: *628
examples:
- default: *802
+ default: *797
headers:
Link: *45
'304': *35
@@ -121412,7 +120771,7 @@ paths:
application/json:
schema:
type: array
- items: &803
+ items: &798
title: Social account
description: Social media account
type: object
@@ -121429,7 +120788,7 @@ paths:
- provider
- url
examples:
- default: &804
+ default: &799
value:
- provider: twitter
url: https://twitter.com/github
@@ -121492,9 +120851,9 @@ paths:
application/json:
schema:
type: array
- items: *803
+ items: *798
examples:
- default: *804
+ default: *799
'422': *15
'304': *35
'404': *6
@@ -121582,7 +120941,7 @@ paths:
application/json:
schema:
type: array
- items: &805
+ items: &800
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -121602,7 +120961,7 @@ paths:
- title
- created_at
examples:
- default: &830
+ default: &825
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -121667,9 +121026,9 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
- default: &806
+ default: &801
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -121699,7 +121058,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:
- - &807
+ - &802
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -121711,9 +121070,9 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
- default: *806
+ default: *801
'404': *6
'304': *35
'403': *27
@@ -121736,7 +121095,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:
- - *807
+ - *802
responses:
'204':
description: Response
@@ -121765,7 +121124,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:
- - &831
+ - &826
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
@@ -121790,11 +121149,11 @@ paths:
type: array
items: *76
examples:
- default-response: *808
+ default-response: *803
application/vnd.github.v3.star+json:
schema:
type: array
- items: &832
+ items: &827
title: Starred Repository
description: Starred Repository
type: object
@@ -121950,8 +121309,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response if this repository is starred by you
@@ -121979,8 +121338,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -122004,8 +121363,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -122163,10 +121522,10 @@ paths:
application/json:
schema:
oneOf:
- - *783
- - *782
+ - *778
+ - *777
examples:
- default-response: &810
+ default-response: &805
summary: Default response
value:
login: octocat
@@ -122201,7 +121560,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &811
+ response-with-git-hub-plan-information: &806
summary: Response with GitHub plan information
value:
login: octocat
@@ -122323,7 +121682,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *809
+ - *804
- *17
responses:
'200':
@@ -122372,11 +121731,11 @@ paths:
application/json:
schema:
oneOf:
- - *783
- - *782
+ - *778
+ - *777
examples:
- default-response: *810
- response-with-git-hub-plan-information: *811
+ default-response: *805
+ response-with-git-hub-plan-information: *806
'404': *6
x-github:
githubCloudOnly: false
@@ -122426,8 +121785,8 @@ paths:
required:
- subject_digests
examples:
- default: *812
- withPredicateType: *813
+ default: *807
+ withPredicateType: *808
responses:
'200':
description: Response
@@ -122481,7 +121840,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *814
+ default: *809
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -122686,7 +122045,7 @@ paths:
initiator:
type: string
examples:
- default: *491
+ default: *488
'201':
description: Response
content:
@@ -122727,7 +122086,7 @@ paths:
type: array
items: *373
examples:
- default: *799
+ default: *794
'403': *27
'401': *23
x-github:
@@ -123111,9 +122470,9 @@ paths:
application/json:
schema:
type: array
- items: *790
+ items: *785
examples:
- default: *815
+ default: *810
headers:
Link: *45
x-github:
@@ -123217,7 +122576,7 @@ paths:
application/json:
schema: *20
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123342,7 +122701,7 @@ paths:
- docker
- nuget
- container
- - *798
+ - *793
- *136
- *19
- *17
@@ -123355,10 +122714,10 @@ paths:
type: array
items: *373
examples:
- default: *799
+ default: *794
'403': *27
'401': *23
- '400': *800
+ '400': *795
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123388,7 +122747,7 @@ paths:
application/json:
schema: *373
examples:
- default: *816
+ default: *811
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123737,7 +123096,7 @@ paths:
type: array
items: *394
examples:
- default: *817
+ default: *812
headers:
Link: *45
'304': *35
@@ -123797,7 +123156,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *818
+ items: *813
required:
- name
- data_type
@@ -123813,7 +123172,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *819
+ iteration_configuration: *814
required:
- name
- data_type
@@ -123835,8 +123194,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *820
- iteration_field: *821
+ single_select_field: *815
+ iteration_field: *816
responses:
'201':
description: Response
@@ -123844,11 +123203,11 @@ paths:
application/json:
schema: *394
examples:
- text_field: *822
- number_field: *823
- date_field: *824
- single_select_field: *825
- iteration_field: *826
+ text_field: *817
+ number_field: *818
+ date_field: *819
+ single_select_field: *820
+ iteration_field: *821
'304': *35
'403': *27
'401': *23
@@ -123870,7 +123229,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *391
- - *827
+ - *822
- *136
responses:
'200':
@@ -123879,7 +123238,7 @@ paths:
application/json:
schema: *394
examples:
- default: *828
+ default: *823
headers:
Link: *45
'304': *35
@@ -124232,7 +123591,7 @@ paths:
parameters:
- *391
- *136
- - *829
+ - *824
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -124511,9 +123870,9 @@ paths:
application/json:
schema:
type: array
- items: *803
+ items: *798
examples:
- default: *804
+ default: *799
headers:
Link: *45
x-github:
@@ -124543,9 +123902,9 @@ paths:
application/json:
schema:
type: array
- items: *805
+ items: *800
examples:
- default: *830
+ default: *825
headers:
Link: *45
x-github:
@@ -124570,7 +123929,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *136
- - *831
+ - *826
- *108
- *17
- *19
@@ -124582,11 +123941,11 @@ paths:
schema:
anyOf:
- type: array
- items: *832
+ items: *827
- type: array
items: *76
examples:
- default-response: *808
+ default-response: *803
headers:
Link: *45
x-github:
@@ -124746,7 +124105,7 @@ webhooks:
type: string
enum:
- disabled
- enterprise: &833
+ enterprise: &828
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -124815,7 +124174,7 @@ webhooks:
- created_at
- updated_at
- avatar_url
- installation: &834
+ installation: &829
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -124836,7 +124195,7 @@ webhooks:
required:
- id
- node_id
- organization: &835
+ organization: &830
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -124909,7 +124268,7 @@ webhooks:
- public_members_url
- avatar_url
- description
- repository: &836
+ repository: &831
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
@@ -125822,10 +125181,10 @@ webhooks:
type: string
enum:
- enabled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -125901,11 +125260,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: &837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: &832
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)
@@ -126128,11 +125487,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: *832
sender: *4
required:
- action
@@ -126320,11 +125679,11 @@ webhooks:
- everyone
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: *832
sender: *4
required:
- action
@@ -126397,7 +125756,7 @@ webhooks:
required: true
content:
application/json:
- schema: &857
+ schema: &852
title: Exemption request cancellation event
type: object
properties:
@@ -126405,11 +125764,11 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: &838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: &833
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -126683,7 +126042,7 @@ webhooks:
- array
- 'null'
description: The responses to the exemption request.
- items: &839
+ items: &834
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -126795,7 +126154,7 @@ webhooks:
required: true
content:
application/json:
- schema: &858
+ schema: &853
title: Exemption request completed event
type: object
properties:
@@ -126803,11 +126162,11 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
sender: *4
required:
- action
@@ -126879,7 +126238,7 @@ webhooks:
required: true
content:
application/json:
- schema: &855
+ schema: &850
title: Exemption request created event
type: object
properties:
@@ -126887,11 +126246,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
sender: *4
required:
- action
@@ -126963,7 +126322,7 @@ webhooks:
required: true
content:
application/json:
- schema: &859
+ schema: &854
title: Exemption response dismissed event
type: object
properties:
@@ -126971,12 +126330,12 @@ webhooks:
type: string
enum:
- response_dismissed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
- exemption_response: *839
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
+ exemption_response: *834
sender: *4
required:
- action
@@ -127050,7 +126409,7 @@ webhooks:
required: true
content:
application/json:
- schema: &856
+ schema: &851
title: Exemption response submitted event
type: object
properties:
@@ -127058,12 +126417,12 @@ webhooks:
type: string
enum:
- response_submitted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
- exemption_response: *839
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
+ exemption_response: *834
sender: *4
required:
- action
@@ -127147,7 +126506,7 @@ webhooks:
type: string
enum:
- completed
- check_run: &841
+ check_run: &836
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -127257,7 +126616,7 @@ webhooks:
-
examples:
- neutral
- deployment: *840
+ deployment: *835
details_url:
type: string
examples:
@@ -127355,10 +126714,10 @@ webhooks:
- output
- app
- pull_requests
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -127751,11 +127110,11 @@ webhooks:
type: string
enum:
- created
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -128151,11 +127510,11 @@ webhooks:
type: string
enum:
- requested_action
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
requested_action:
description: The action requested by the user.
type: object
@@ -128560,11 +127919,11 @@ webhooks:
type: string
enum:
- rerequested
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -129556,10 +128915,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -130268,10 +129627,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -130974,10 +130333,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -131146,7 +130505,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -131298,20 +130657,20 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &842
+ commit_oid: &837
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: *833
- installation: *834
- organization: *835
- ref: &843
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: &838
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: *836
+ repository: *831
sender: *4
required:
- action
@@ -131478,7 +130837,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -131719,12 +131078,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -131822,7 +131181,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132007,12 +131366,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -132181,7 +131540,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -132358,12 +131717,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -132464,7 +131823,7 @@ webhooks:
type:
- object
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132653,9 +132012,9 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
@@ -132663,7 +132022,7 @@ webhooks:
type:
- string
- 'null'
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -132762,7 +132121,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132909,12 +132268,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -133083,7 +132442,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -133235,10 +132594,10 @@ webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -133498,10 +132857,10 @@ webhooks:
- updated_at
- author_association
- body
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -133582,18 +132941,18 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *835
- pusher_type: &844
+ organization: *830
+ pusher_type: &839
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &845
+ ref: &840
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -133603,7 +132962,7 @@ webhooks:
enum:
- tag
- branch
- repository: *836
+ repository: *831
sender: *4
required:
- ref
@@ -133686,9 +133045,9 @@ webhooks:
enum:
- created
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133773,9 +133132,9 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133853,9 +133212,9 @@ webhooks:
enum:
- promote_to_enterprise
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133933,9 +133292,9 @@ webhooks:
enum:
- updated
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -134012,10 +133371,10 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- repository: *836
- organization: *835
+ enterprise: *828
+ installation: *829
+ repository: *831
+ organization: *830
sender: *4
new_property_values:
type: array
@@ -134100,18 +133459,18 @@ webhooks:
title: delete event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- pusher_type: *844
- ref: *845
+ enterprise: *828
+ installation: *829
+ organization: *830
+ pusher_type: *839
+ ref: *840
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *836
+ repository: *831
sender: *4
required:
- ref
@@ -134195,11 +133554,11 @@ webhooks:
type: string
enum:
- auto_dismissed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134283,11 +133642,11 @@ webhooks:
type: string
enum:
- auto_reopened
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134371,11 +133730,11 @@ webhooks:
type: string
enum:
- created
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134457,11 +133816,11 @@ webhooks:
type: string
enum:
- dismissed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134543,11 +133902,11 @@ webhooks:
type: string
enum:
- fixed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134630,11 +133989,11 @@ webhooks:
type: string
enum:
- reintroduced
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134716,11 +134075,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134797,9 +134156,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- key: &846
+ enterprise: *828
+ installation: *829
+ key: &841
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -134837,8 +134196,8 @@ webhooks:
- verified
- created_at
- read_only
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -134915,11 +134274,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- key: *846
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ key: *841
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -135491,12 +134850,12 @@ webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: &850
+ workflow: &845
title: Workflow
type:
- object
@@ -136234,13 +135593,13 @@ webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *583
+ deployment: *580
pull_requests:
type: array
- items: *678
- repository: *836
- organization: *835
- installation: *834
+ items: *675
+ repository: *831
+ organization: *830
+ installation: *829
sender: *4
responses:
'200':
@@ -136311,7 +135670,7 @@ webhooks:
type: string
enum:
- approved
- approver: &847
+ approver: &842
type: object
properties:
avatar_url:
@@ -136354,11 +135713,11 @@ webhooks:
type: string
comment:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- reviewers: &848
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ reviewers: &843
type: array
items:
type: object
@@ -136439,7 +135798,7 @@ webhooks:
sender: *4
since:
type: string
- workflow_job_run: &849
+ workflow_job_run: &844
type: object
properties:
conclusion:
@@ -137185,18 +136544,18 @@ webhooks:
type: string
enum:
- rejected
- approver: *847
+ approver: *842
comment:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- reviewers: *848
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ reviewers: *843
sender: *4
since:
type: string
- workflow_job_run: *849
+ workflow_job_run: *844
workflow_job_runs:
type: array
items:
@@ -137913,13 +137272,13 @@ webhooks:
type: string
enum:
- requested
- enterprise: *833
+ enterprise: *828
environment:
type: string
- installation: *834
- organization: *835
- repository: *836
- requestor: &860
+ installation: *829
+ organization: *830
+ repository: *831
+ requestor: &855
title: User
type:
- object
@@ -139862,12 +139221,12 @@ webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Deployment Workflow Run
type:
@@ -140558,7 +139917,7 @@ webhooks:
type: string
enum:
- answered
- answer: &853
+ answer: &848
type: object
properties:
author_association:
@@ -140718,11 +140077,11 @@ webhooks:
- created_at
- updated_at
- body
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -140849,11 +140208,11 @@ webhooks:
- from
required:
- category
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -140936,11 +140295,11 @@ webhooks:
type: string
enum:
- closed
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141022,7 +140381,7 @@ webhooks:
type: string
enum:
- created
- comment: &852
+ comment: &847
type: object
properties:
author_association:
@@ -141182,11 +140541,11 @@ webhooks:
- updated_at
- body
- reactions
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141269,12 +140628,12 @@ webhooks:
type: string
enum:
- deleted
- comment: *852
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ comment: *847
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141369,12 +140728,12 @@ webhooks:
- from
required:
- body
- comment: *852
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ comment: *847
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141458,11 +140817,11 @@ webhooks:
type: string
enum:
- created
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141544,11 +140903,11 @@ webhooks:
type: string
enum:
- deleted
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141648,11 +141007,11 @@ webhooks:
type: string
required:
- from
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141734,10 +141093,10 @@ webhooks:
type: string
enum:
- labeled
- discussion: *851
- enterprise: *833
- installation: *834
- label: &854
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ label: &849
title: Label
type: object
properties:
@@ -141770,8 +141129,8 @@ webhooks:
- color
- default
- description
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141854,11 +141213,11 @@ webhooks:
type: string
enum:
- locked
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141940,11 +141299,11 @@ webhooks:
type: string
enum:
- pinned
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142026,11 +141385,11 @@ webhooks:
type: string
enum:
- reopened
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142115,16 +141474,16 @@ webhooks:
changes:
type: object
properties:
- new_discussion: *851
- new_repository: *836
+ new_discussion: *846
+ new_repository: *831
required:
- new_discussion
- new_repository
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142207,10 +141566,10 @@ webhooks:
type: string
enum:
- unanswered
- discussion: *851
- old_answer: *853
- organization: *835
- repository: *836
+ discussion: *846
+ old_answer: *848
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142292,12 +141651,12 @@ webhooks:
type: string
enum:
- unlabeled
- discussion: *851
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142380,11 +141739,11 @@ webhooks:
type: string
enum:
- unlocked
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142466,11 +141825,11 @@ webhooks:
type: string
enum:
- unpinned
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142539,7 +141898,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142602,7 +141961,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142665,7 +142024,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142728,7 +142087,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142791,7 +142150,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142857,7 +142216,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142923,7 +142282,7 @@ webhooks:
required: true
content:
application/json:
- schema: *858
+ schema: *853
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142989,7 +142348,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143055,7 +142414,7 @@ webhooks:
required: true
content:
application/json:
- schema: *859
+ schema: *854
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143121,7 +142480,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143186,7 +142545,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143251,7 +142610,7 @@ webhooks:
required: true
content:
application/json:
- schema: *858
+ schema: *853
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143316,7 +142675,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143381,7 +142740,7 @@ webhooks:
required: true
content:
application/json:
- schema: *859
+ schema: *854
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143447,7 +142806,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143514,7 +142873,7 @@ webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *833
+ enterprise: *828
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -144192,9 +143551,9 @@ webhooks:
type: integer
watchers_count:
type: integer
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- forkee
@@ -144340,9 +143699,9 @@ webhooks:
title: gollum event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pages:
description: The pages that were updated.
type: array
@@ -144380,7 +143739,7 @@ webhooks:
- action
- sha
- html_url
- repository: *836
+ repository: *831
sender: *4
required:
- pages
@@ -144456,10 +143815,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: &861
+ organization: *830
+ repositories: &856
description: An array of repository objects that the installation
can access.
type: array
@@ -144485,8 +143844,8 @@ webhooks:
- name
- full_name
- private
- repository: *836
- requester: *860
+ repository: *831
+ requester: *855
sender: *4
required:
- action
@@ -144561,11 +143920,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -144642,11 +144001,11 @@ webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -144723,10 +144082,10 @@ webhooks:
type: string
enum:
- added
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories_added: &862
+ organization: *830
+ repositories_added: &857
description: An array of repository objects, which were added to
the installation.
type: array
@@ -144772,15 +144131,15 @@ webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *836
- repository_selection: &863
+ repository: *831
+ repository_selection: &858
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *860
+ requester: *855
sender: *4
required:
- action
@@ -144859,10 +144218,10 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories_added: *862
+ organization: *830
+ repositories_added: *857
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -144889,9 +144248,9 @@ webhooks:
- name
- full_name
- private
- repository: *836
- repository_selection: *863
- requester: *860
+ repository: *831
+ repository_selection: *858
+ requester: *855
sender: *4
required:
- action
@@ -144970,11 +144329,11 @@ webhooks:
type: string
enum:
- suspend
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -145157,10 +144516,10 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
target_type:
type: string
@@ -145239,11 +144598,11 @@ webhooks:
type: string
enum:
- unsuspend
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -145491,8 +144850,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -146309,8 +145668,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -146671,8 +146030,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -146752,7 +146111,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &864
+ comment: &859
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -146919,8 +146278,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -147733,8 +147092,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148097,8 +147456,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -148178,7 +147537,7 @@ webhooks:
type: string
enum:
- edited
- changes: &888
+ changes: &883
description: The changes to the comment.
type: object
properties:
@@ -148190,9 +147549,9 @@ webhooks:
type: string
required:
- from
- comment: *864
- enterprise: *833
- installation: *834
+ comment: *859
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -149008,8 +148367,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149370,8 +148729,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149461,9 +148820,9 @@ webhooks:
type: number
blocking_issue: *212
blocking_issue_repo: *76
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149552,9 +148911,9 @@ webhooks:
type: number
blocking_issue: *212
blocking_issue_repo: *76
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149642,9 +149001,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149733,9 +149092,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149815,10 +149174,10 @@ webhooks:
type: string
enum:
- assigned
- assignee: *860
- enterprise: *833
- installation: *834
- issue: &867
+ assignee: *855
+ enterprise: *828
+ installation: *829
+ issue: &862
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -150630,11 +149989,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150754,8 +150113,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -150835,8 +150194,8 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -151653,11 +151012,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151920,8 +151279,8 @@ webhooks:
required:
- state
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -152000,8 +151359,8 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152809,11 +152168,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152932,8 +152291,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -153012,8 +152371,8 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153844,11 +153203,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153946,7 +153305,7 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: &865
+ milestone: &860
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -154089,8 +153448,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -154189,8 +153548,8 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -155002,11 +154361,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -155126,9 +154485,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *854
- organization: *835
- repository: *836
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -155208,8 +154567,8 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -156020,11 +155379,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156144,9 +155503,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *854
- organization: *835
- repository: *836
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -156226,8 +155585,8 @@ webhooks:
type: string
enum:
- locked
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -157063,11 +156422,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157164,8 +156523,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -157244,8 +156603,8 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -158075,11 +157434,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158176,9 +157535,9 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: *865
- organization: *835
- repository: *836
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -159070,11 +158429,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -159651,8 +159010,8 @@ webhooks:
required:
- old_issue
- old_repository
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -160464,11 +159823,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160587,8 +159946,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -160668,9 +160027,9 @@ webhooks:
type: string
enum:
- pinned
- enterprise: *833
- installation: *834
- issue: &866
+ enterprise: *828
+ installation: *829
+ issue: &861
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -161476,11 +160835,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161599,8 +160958,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -161679,8 +161038,8 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -162514,11 +161873,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -162616,8 +161975,8 @@ webhooks:
user_view_type:
type: string
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -163506,11 +162865,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -164109,11 +163468,11 @@ webhooks:
required:
- new_issue
- new_repository
- enterprise: *833
- installation: *834
- issue: *866
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *861
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164193,12 +163552,12 @@ webhooks:
type: string
enum:
- typed
- enterprise: *833
- installation: *834
- issue: *867
+ enterprise: *828
+ installation: *829
+ issue: *862
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164279,7 +163638,7 @@ webhooks:
type: string
enum:
- unassigned
- assignee: &891
+ assignee: &886
title: User
type:
- object
@@ -164351,11 +163710,11 @@ webhooks:
required:
- login
- id
- enterprise: *833
- installation: *834
- issue: *867
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *862
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164434,12 +163793,12 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *833
- installation: *834
- issue: *867
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *862
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164519,8 +163878,8 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -165354,11 +164713,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -165455,8 +164814,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165536,11 +164895,11 @@ webhooks:
type: string
enum:
- unpinned
- enterprise: *833
- installation: *834
- issue: *866
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *861
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165619,12 +164978,12 @@ webhooks:
type: string
enum:
- untyped
- enterprise: *833
- installation: *834
- issue: *867
+ enterprise: *828
+ installation: *829
+ issue: *862
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165704,11 +165063,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165786,11 +165145,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165900,11 +165259,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165986,9 +165345,9 @@ webhooks:
- cancelled
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: &868
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: &863
title: Marketplace Purchase
type: object
required:
@@ -166076,8 +165435,8 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *835
- previous_marketplace_purchase: &869
+ organization: *830
+ previous_marketplace_purchase: &864
title: Marketplace Purchase
type: object
properties:
@@ -166161,7 +165520,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166241,10 +165600,10 @@ webhooks:
- changed
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166332,7 +165691,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166414,10 +165773,10 @@ webhooks:
- pending_change
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166503,7 +165862,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166584,8 +165943,8 @@ webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166671,9 +166030,9 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *835
- previous_marketplace_purchase: *869
- repository: *836
+ organization: *830
+ previous_marketplace_purchase: *864
+ repository: *831
sender: *4
required:
- action
@@ -166753,12 +166112,12 @@ webhooks:
- purchased
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
- previous_marketplace_purchase: *869
- repository: *836
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
+ previous_marketplace_purchase: *864
+ repository: *831
sender: *4
required:
- action
@@ -166860,11 +166219,11 @@ webhooks:
type: string
required:
- to
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -166966,11 +166325,11 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167049,11 +166408,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167131,11 +166490,11 @@ webhooks:
type: string
enum:
- added
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -167213,7 +166572,7 @@ webhooks:
required:
- login
- id
- team: &870
+ team: &865
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -167443,11 +166802,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -167526,7 +166885,7 @@ webhooks:
required:
- login
- id
- team: *870
+ team: *865
required:
- action
- scope
@@ -167608,8 +166967,8 @@ webhooks:
type: string
enum:
- checks_requested
- installation: *834
- merge_group: &871
+ installation: *829
+ merge_group: &866
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -167628,15 +166987,15 @@ webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *511
+ head_commit: *508
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167722,10 +167081,10 @@ webhooks:
- merged
- invalidated
- dequeued
- installation: *834
- merge_group: *871
- organization: *835
- repository: *836
+ installation: *829
+ merge_group: *866
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167798,7 +167157,7 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
+ enterprise: *828
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -167907,12 +167266,12 @@ webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -167992,11 +167351,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168075,9 +167434,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- milestone: &872
+ enterprise: *828
+ installation: *829
+ milestone: &867
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -168219,8 +167578,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168299,11 +167658,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168413,11 +167772,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168497,11 +167856,11 @@ webhooks:
type: string
enum:
- opened
- enterprise: *833
- installation: *834
- milestone: *872
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *867
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168580,11 +167939,11 @@ webhooks:
type: string
enum:
- blocked
- blocked_user: *860
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ blocked_user: *855
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168663,11 +168022,11 @@ webhooks:
type: string
enum:
- unblocked
- blocked_user: *860
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ blocked_user: *855
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168743,7 +168102,7 @@ webhooks:
enum:
- created
definition: *144
- enterprise: *833
+ enterprise: *828
sender: *4
required:
- action
@@ -168823,8 +168182,8 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
sender: *4
required:
- action
@@ -168897,8 +168256,8 @@ webhooks:
enum:
- updated
definition: *144
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
sender: *4
required:
- action
@@ -168970,9 +168329,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
new_property_values:
type: array
@@ -169060,9 +168419,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- membership: &873
+ enterprise: *828
+ installation: *829
+ membership: &868
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -169172,8 +168531,8 @@ webhooks:
- role
- organization_url
- user
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169251,11 +168610,11 @@ webhooks:
type: string
enum:
- member_added
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169334,8 +168693,8 @@ webhooks:
type: string
enum:
- member_invited
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -169457,10 +168816,10 @@ webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
- user: *860
+ user: *855
required:
- action
- invitation
@@ -169538,11 +168897,11 @@ webhooks:
type: string
enum:
- member_removed
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169629,11 +168988,11 @@ webhooks:
properties:
from:
type: string
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169709,9 +169068,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
package:
description: Information about the package.
type: object
@@ -170234,7 +169593,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: &874
+ items: &869
title: Ruby Gems metadata
type: object
properties:
@@ -170331,7 +169690,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -170407,9 +169766,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
package:
description: Information about the package.
type: object
@@ -170771,7 +170130,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *874
+ items: *869
source_url:
type: string
format: uri
@@ -170842,7 +170201,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -171023,12 +170382,12 @@ webhooks:
- duration
- created_at
- updated_at
- enterprise: *833
+ enterprise: *828
id:
type: integer
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- id
@@ -171105,7 +170464,7 @@ webhooks:
type: string
enum:
- approved
- personal_access_token_request: &875
+ personal_access_token_request: &870
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -171255,10 +170614,10 @@ webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *833
- organization: *835
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171335,11 +170694,11 @@ webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *875
- enterprise: *833
- organization: *835
+ personal_access_token_request: *870
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171415,11 +170774,11 @@ webhooks:
type: string
enum:
- created
- personal_access_token_request: *875
- enterprise: *833
- organization: *835
+ personal_access_token_request: *870
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171494,11 +170853,11 @@ webhooks:
type: string
enum:
- denied
- personal_access_token_request: *875
- organization: *835
- enterprise: *833
+ personal_access_token_request: *870
+ organization: *830
+ enterprise: *828
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171603,7 +170962,7 @@ webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *876
+ last_response: *871
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -171635,8 +170994,8 @@ webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
zen:
description: Random string of GitHub zen.
@@ -171881,10 +171240,10 @@ webhooks:
- from
required:
- note
- enterprise: *833
- installation: *834
- organization: *835
- project_card: &877
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: &872
title: Project Card
type: object
properties:
@@ -172007,7 +171366,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172088,11 +171447,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project_card: *877
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: *872
+ repository: *831
sender: *4
required:
- action
@@ -172172,9 +171531,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
project_card:
title: Project Card
type: object
@@ -172304,7 +171663,7 @@ webhooks:
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -172398,11 +171757,11 @@ webhooks:
- from
required:
- note
- enterprise: *833
- installation: *834
- organization: *835
- project_card: *877
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: *872
+ repository: *831
sender: *4
required:
- action
@@ -172496,9 +171855,9 @@ webhooks:
- from
required:
- column_id
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
project_card:
allOf:
- title: Project Card
@@ -172695,7 +172054,7 @@ webhooks:
type: string
required:
- after_id
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172775,10 +172134,10 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- organization: *835
- project: &879
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: &874
title: Project
type: object
properties:
@@ -172905,7 +172264,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172985,10 +172344,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project_column: &878
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: &873
title: Project Column
type: object
properties:
@@ -173028,7 +172387,7 @@ webhooks:
- name
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -173107,14 +172466,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -173203,11 +172562,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
+ repository: *831
sender: *4
required:
- action
@@ -173287,11 +172646,11 @@ webhooks:
type: string
enum:
- moved
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
+ repository: *831
sender: *4
required:
- action
@@ -173371,11 +172730,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173455,14 +172814,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -173563,11 +172922,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173646,11 +173005,11 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173731,8 +173090,8 @@ webhooks:
type: string
enum:
- closed
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -173814,8 +173173,8 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -173897,8 +173256,8 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174020,8 +173379,8 @@ webhooks:
type: string
to:
type: string
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174105,7 +173464,7 @@ webhooks:
type: string
enum:
- archived
- changes: &883
+ changes: &878
type: object
properties:
archived_at:
@@ -174121,9 +173480,9 @@ webhooks:
- string
- 'null'
format: date-time
- installation: *834
- organization: *835
- projects_v2_item: &880
+ installation: *829
+ organization: *830
+ projects_v2_item: &875
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -174263,9 +173622,9 @@ webhooks:
- 'null'
to:
type: string
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174347,9 +173706,9 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174430,9 +173789,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174537,7 +173896,7 @@ webhooks:
oneOf:
- type: string
- type: integer
- - &881
+ - &876
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -174561,7 +173920,7 @@ webhooks:
required:
- id
- name
- - &882
+ - &877
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -174601,8 +173960,8 @@ webhooks:
oneOf:
- type: string
- type: integer
- - *881
- - *882
+ - *876
+ - *877
type:
- 'null'
- string
@@ -174625,9 +173984,9 @@ webhooks:
- 'null'
required:
- body
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174724,9 +174083,9 @@ webhooks:
type:
- string
- 'null'
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174809,10 +174168,10 @@ webhooks:
type: string
enum:
- restored
- changes: *883
- installation: *834
- organization: *835
- projects_v2_item: *880
+ changes: *878
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174894,8 +174253,8 @@ webhooks:
type: string
enum:
- reopened
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174977,9 +174336,9 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175060,9 +174419,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175208,9 +174567,9 @@ webhooks:
- string
- 'null'
format: date
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175281,10 +174640,10 @@ webhooks:
title: public event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- repository
@@ -175361,13 +174720,13 @@ webhooks:
type: string
enum:
- assigned
- assignee: *860
- enterprise: *833
- installation: *834
- number: &885
+ assignee: *855
+ enterprise: *828
+ installation: *829
+ number: &880
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -177716,7 +177075,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -177798,11 +177157,11 @@ webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -180144,7 +179503,7 @@ webhooks:
- draft
reason:
type: string
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -180226,11 +179585,11 @@ webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -182572,7 +181931,7 @@ webhooks:
- draft
reason:
type: string
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -182654,13 +182013,13 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: &886
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: &881
allOf:
- - *678
+ - *675
- type: object
properties:
allow_auto_merge:
@@ -182722,7 +182081,7 @@ webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -182803,12 +182162,12 @@ webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -182888,11 +182247,11 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *833
+ enterprise: *828
milestone: *392
- number: *885
- organization: *835
- pull_request: &887
+ number: *880
+ organization: *830
+ pull_request: &882
title: Pull Request
type: object
properties:
@@ -185219,7 +184578,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -185298,11 +184657,11 @@ webhooks:
type: string
enum:
- dequeued
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -187648,7 +187007,7 @@ webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -187772,12 +187131,12 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -187857,11 +187216,11 @@ webhooks:
type: string
enum:
- enqueued
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -190192,7 +189551,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -190272,11 +189631,11 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *833
- installation: *834
- label: *854
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ label: *849
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -192624,7 +191983,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -192705,10 +192064,10 @@ webhooks:
type: string
enum:
- locked
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -195054,7 +194413,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -195134,12 +194493,12 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *833
+ enterprise: *828
milestone: *392
- number: *885
- organization: *835
- pull_request: *887
- repository: *836
+ number: *880
+ organization: *830
+ pull_request: *882
+ repository: *831
sender: *4
required:
- action
@@ -195218,12 +194577,12 @@ webhooks:
type: string
enum:
- opened
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195304,12 +194663,12 @@ webhooks:
type: string
enum:
- ready_for_review
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195389,12 +194748,12 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195769,9 +195128,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -198001,7 +197360,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -198081,7 +197440,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &889
+ comment: &884
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.
@@ -198374,9 +197733,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -200594,7 +199953,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -200674,11 +200033,11 @@ webhooks:
type: string
enum:
- edited
- changes: *888
- comment: *889
- enterprise: *833
- installation: *834
- organization: *835
+ changes: *883
+ comment: *884
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -202899,7 +202258,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -202980,9 +202339,9 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -205215,7 +204574,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
review:
description: The review that was affected.
type: object
@@ -205466,9 +204825,9 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -207582,8 +206941,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
- review: &890
+ repository: *831
+ review: &885
description: The review that was affected.
type: object
properties:
@@ -207821,12 +207180,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -210173,7 +209532,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_reviewer:
title: User
type:
@@ -210259,12 +209618,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -212618,7 +211977,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -212813,12 +212172,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -215167,7 +214526,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_reviewer:
title: User
type:
@@ -215254,12 +214613,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -217599,7 +216958,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -217783,9 +217142,9 @@ webhooks:
type: string
enum:
- submitted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -220021,8 +219380,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
- review: *890
+ repository: *831
+ review: *885
sender: *4
required:
- action
@@ -220102,9 +219461,9 @@ webhooks:
type: string
enum:
- resolved
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -222235,7 +221594,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
thread:
type: object
@@ -222632,9 +221991,9 @@ webhooks:
type: string
enum:
- unresolved
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -224748,7 +224107,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
thread:
type: object
@@ -225147,10 +224506,10 @@ webhooks:
type: string
before:
type: string
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -227485,7 +226844,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -227567,11 +226926,11 @@ webhooks:
type: string
enum:
- unassigned
- assignee: *891
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ assignee: *886
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -229921,7 +229280,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -230000,11 +229359,11 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *833
- installation: *834
- label: *854
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ label: *849
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -232343,7 +231702,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -232424,10 +231783,10 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -234756,7 +234115,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -234959,7 +234318,7 @@ webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *833
+ enterprise: *828
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -235054,8 +234413,8 @@ webhooks:
- url
- author
- committer
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -235643,9 +235002,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
registry_package:
type: object
properties:
@@ -236122,7 +235481,7 @@ webhooks:
type: string
rubygems_metadata:
type: array
- items: *874
+ items: *869
summary:
type: string
tag_name:
@@ -236178,7 +235537,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -236256,9 +235615,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
registry_package:
type: object
properties:
@@ -236570,7 +235929,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *874
+ items: *869
summary:
type: string
tag_name:
@@ -236620,7 +235979,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -236697,10 +236056,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- release: &892
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: &887
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -237031,7 +236390,7 @@ webhooks:
- updated_at
- zipball_url
- body
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -237108,11 +236467,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -237229,11 +236588,11 @@ webhooks:
type: boolean
required:
- to
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -237311,9 +236670,9 @@ webhooks:
type: string
enum:
- prereleased
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -237649,7 +237008,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -237725,10 +237084,10 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- release: &893
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: &888
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -238061,7 +237420,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -238137,11 +237496,11 @@ webhooks:
type: string
enum:
- released
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -238217,11 +237576,11 @@ webhooks:
type: string
enum:
- unpublished
- enterprise: *833
- installation: *834
- organization: *835
- release: *893
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *888
+ repository: *831
sender: *4
required:
- action
@@ -238297,11 +237656,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- repository_advisory: *730
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ repository_advisory: *727
sender: *4
required:
- action
@@ -238377,11 +237736,11 @@ webhooks:
type: string
enum:
- reported
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- repository_advisory: *730
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ repository_advisory: *727
sender: *4
required:
- action
@@ -238457,10 +237816,10 @@ webhooks:
type: string
enum:
- archived
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238537,10 +237896,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238618,10 +237977,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238706,10 +238065,10 @@ webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238824,10 +238183,10 @@ webhooks:
- 'null'
items:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238899,10 +238258,10 @@ webhooks:
title: repository_import event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
status:
type: string
@@ -238983,10 +238342,10 @@ webhooks:
type: string
enum:
- privatized
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239063,10 +238422,10 @@ webhooks:
type: string
enum:
- publicized
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239160,10 +238519,10 @@ webhooks:
- name
required:
- repository
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239243,10 +238602,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
sender: *4
required:
@@ -239325,10 +238684,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
sender: *4
required:
@@ -239407,10 +238766,10 @@ webhooks:
type: string
enum:
- edited
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
changes:
type: object
@@ -239472,16 +238831,16 @@ webhooks:
properties:
added:
type: array
- items: *698
+ items: *695
deleted:
type: array
- items: *698
+ items: *695
updated:
type: array
items:
type: object
properties:
- rule: *698
+ rule: *695
changes:
type: object
properties:
@@ -239718,10 +239077,10 @@ webhooks:
- from
required:
- owner
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239799,10 +239158,10 @@ webhooks:
type: string
enum:
- unarchived
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239880,7 +239239,7 @@ webhooks:
type: string
enum:
- create
- alert: &894
+ alert: &889
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -240004,10 +239363,10 @@ webhooks:
type: string
enum:
- open
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240217,10 +239576,10 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240298,11 +239657,11 @@ webhooks:
type: string
enum:
- reopen
- alert: *894
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *889
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240504,10 +239863,10 @@ webhooks:
enum:
- fixed
- open
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240585,7 +239944,7 @@ webhooks:
type: string
enum:
- assigned
- alert: &895
+ alert: &890
type: object
properties:
number: *123
@@ -240700,10 +240059,10 @@ webhooks:
- type: 'null'
- *4
assignee: *4
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240781,11 +240140,11 @@ webhooks:
type: string
enum:
- created
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240866,11 +240225,11 @@ webhooks:
type: string
enum:
- created
- alert: *895
- installation: *834
- location: *896
- organization: *835
- repository: *836
+ alert: *890
+ installation: *829
+ location: *891
+ organization: *830
+ repository: *831
sender: *4
required:
- location
@@ -241108,11 +240467,11 @@ webhooks:
type: string
enum:
- publicly_leaked
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241190,11 +240549,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241272,11 +240631,11 @@ webhooks:
type: string
enum:
- resolved
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241354,12 +240713,12 @@ webhooks:
type: string
enum:
- unassigned
- alert: *895
+ alert: *890
assignee: *4
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241437,11 +240796,11 @@ webhooks:
type: string
enum:
- validated
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241571,10 +240930,10 @@ webhooks:
- organization
- enterprise
-
- repository: *836
- enterprise: *833
- installation: *834
- organization: *835
+ repository: *831
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -241652,11 +241011,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- security_advisory: &897
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ security_advisory: &892
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -241842,11 +241201,11 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- security_advisory: *897
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ security_advisory: *892
sender: *4
required:
- action
@@ -241919,10 +241278,10 @@ webhooks:
type: string
enum:
- withdrawn
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -242109,10 +241468,10 @@ webhooks:
type: object
properties:
security_and_analysis: *402
- enterprise: *833
- installation: *834
- organization: *835
- repository: *449
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *446
sender: *4
required:
- changes
@@ -242190,12 +241549,12 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: &898
+ sponsorship: &893
type: object
properties:
created_at:
@@ -242500,12 +241859,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- sponsorship
@@ -242593,12 +241952,12 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242675,17 +242034,17 @@ webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &899
+ effective_date: &894
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: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- sponsorship
@@ -242759,7 +242118,7 @@ webhooks:
type: string
enum:
- pending_tier_change
- changes: &900
+ changes: &895
type: object
properties:
tier:
@@ -242803,13 +242162,13 @@ webhooks:
- from
required:
- tier
- effective_date: *899
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ effective_date: *894
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242886,13 +242245,13 @@ webhooks:
type: string
enum:
- tier_changed
- changes: *900
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ changes: *895
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242966,10 +242325,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -243053,10 +242412,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -243490,15 +242849,15 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
+ enterprise: *828
id:
description: The unique identifier of the status.
type: integer
- installation: *834
+ installation: *829
name:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
sha:
description: The Commit SHA.
@@ -243614,9 +242973,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243706,9 +243065,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243798,9 +243157,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243890,9 +243249,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243969,12 +243328,12 @@ webhooks:
title: team_add event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- team: &901
+ team: &896
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -244204,9 +243563,9 @@ webhooks:
type: string
enum:
- added_to_repository
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -244676,7 +244035,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -244752,9 +244111,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -245224,7 +244583,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -245301,9 +244660,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -245773,7 +245132,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -245917,9 +245276,9 @@ webhooks:
- from
required:
- permissions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -246389,7 +245748,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- changes
@@ -246467,9 +245826,9 @@ webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -246939,7 +246298,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -247015,10 +246374,10 @@ webhooks:
type: string
enum:
- started
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -247091,17 +246450,17 @@ webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *833
+ enterprise: *828
inputs:
type:
- object
- 'null'
additionalProperties: true
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
ref:
type: string
- repository: *836
+ repository: *831
sender: *4
workflow:
type: string
@@ -247183,10 +246542,10 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
allOf:
@@ -247442,7 +246801,7 @@ webhooks:
type: string
required:
- conclusion
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -247521,10 +246880,10 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
allOf:
@@ -247806,7 +247165,7 @@ webhooks:
required:
- status
- steps
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -247885,10 +247244,10 @@ webhooks:
type: string
enum:
- queued
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
type: object
@@ -248034,7 +247393,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -248113,10 +247472,10 @@ webhooks:
type: string
enum:
- waiting
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
type: object
@@ -248263,7 +247622,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -248343,12 +247702,12 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
@@ -249367,12 +248726,12 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
@@ -250376,12 +249735,12 @@ webhooks:
type: string
enum:
- requested
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json
index 80d080638..47bb3ad4d 100644
--- a/descriptions-next/ghec/dereferenced/ghec.deref.json
+++ b/descriptions-next/ghec/dereferenced/ghec.deref.json
@@ -285322,19 +285322,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -285466,8 +285453,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -285509,8 +285494,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",
@@ -285830,19 +285813,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -285974,8 +285944,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286015,8 +285983,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",
@@ -286302,19 +286268,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -286446,8 +286399,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286487,8 +286438,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",
@@ -286798,19 +286747,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -286942,8 +286878,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -286983,8 +286917,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",
@@ -287075,17 +287007,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": [
{
@@ -287105,28 +287037,406 @@
"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",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "type": "string",
+ "examples": [
+ "2019-06-03 22:27:15:000 -700"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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",
+ "examples": [
+ 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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "type": "string",
+ "examples": [
+ "2021-01-03 22:27:15:000 -700"
+ ]
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "type": "string",
+ "examples": [
+ "team-test"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ]
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "type": "string",
+ "examples": [
+ "mona-lisa_eocsaxrs"
+ ]
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "type": "string",
+ "examples": [
+ "Mona Lisa"
+ ]
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "type": "string",
+ "examples": [
+ "mona_lisa@github.com"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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"
}
},
{
@@ -287156,322 +287466,543 @@
"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": {
- "anyOf": [
- {
- "type": "null"
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "failed_reason": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "inviter": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
},
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
]
},
- "body": {
- "description": "The main text of the comment.",
+ "team_count": {
+ "type": "integer"
+ },
+ "node_id": {
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
]
},
- "body_html": {
+ "invitation_teams_url": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "\"https://api.github.com/organizations/16/invitations/1/teams\""
]
},
- "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.",
+ "invitation_source": {
"type": "string",
"examples": [
- "0307116bbf7ced493b8d8a346c650b71"
+ "\"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": {
+ "type": [
+ "string",
+ "null"
]
},
- "created_at": {
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "octocat"
]
},
- "last_edited_at": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
"type": [
"string",
"null"
],
- "format": "date-time"
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "https://api.github.com/users/octocat"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/octocat"
]
},
- "node_id": {
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "https://api.github.com/users/octocat/followers"
]
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
+ "following_url": {
+ "type": "string",
"examples": [
- 42
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
]
},
- "url": {
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "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",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
},
"required": [
- "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"
]
}
@@ -287480,49 +288011,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
}
]
}
@@ -287543,19 +288049,126 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "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",
+ "type": "string",
+ "examples": [
+ "member"
+ ]
+ },
+ "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"
}
},
- "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.",
+ "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/create-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#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -287577,35 +288190,38 @@
}
},
{
- "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"
}
}
],
"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"
}
}
}
@@ -287613,403 +288229,83 @@
}
},
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
+ "url": {
"type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "format": "uri"
},
- "last_edited_at": {
- "type": [
- "string",
- "null"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
+ "default": "member",
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "member"
]
},
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- }
- },
- "/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.",
+ },
+ "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/get-discussion-comment-in-org",
+ "operationId": "teams/remove-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#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -288031,419 +288327,42 @@
}
},
{
- "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"
}
}
],
"responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "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
- }
- }
- }
- }
- }
- }
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"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.",
+ }
+ },
+ "/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/update-discussion-comment-in-org",
+ "operationId": "teams/list-repos-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/teams#list-team-repositories"
},
"parameters": [
{
@@ -288465,995 +288384,62 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "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"
+ "type": "integer",
+ "default": 30
}
},
{
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
+ "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"
+ "type": "integer",
+ "default": 1
}
}
],
- "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": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1296269
+ ]
},
- "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": {
- "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
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
},
- "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/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"
- }
- },
- {
- "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}/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",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "group_name": {
- "description": "The display name of the group",
- "type": "string",
- "examples": [
- "group-azuread-test"
- ]
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "type": "string",
- "examples": [
- "2019-06-03 22:27:15:000 -700"
- ]
- }
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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": "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",
- "examples": [
- 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",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "group_name": {
- "description": "The display name for the group",
- "type": "string",
- "examples": [
- "group-azuread-test"
- ]
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "type": "string",
- "examples": [
- "2021-01-03 22:27:15:000 -700"
- ]
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "team_name": {
- "description": "The name of the team",
- "type": "string",
- "examples": [
- "team-test"
- ]
- }
- }
- },
- "examples": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ]
- },
- "members": {
- "description": "An array of external members linked to this group",
- "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",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "member_login": {
- "description": "The handle/login for the user",
- "type": "string",
- "examples": [
- "mona-lisa_eocsaxrs"
- ]
- },
- "member_name": {
- "description": "The user display name/profile name",
- "type": "string",
- "examples": [
- "Mona Lisa"
- ]
- },
- "member_email": {
- "description": "An email attached to a user",
- "type": "string",
- "examples": [
- "mona_lisa@github.com"
- ]
- }
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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.",
- "in": "path",
- "required": true,
- "schema": {
- "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"
- }
- },
- {
- "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": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": [
- "string",
- "null"
+ "name": {
+ "type": "string",
+ "examples": [
+ "Hello-World"
]
},
- "failed_reason": {
- "type": [
- "string",
- "null"
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
]
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -289621,1196 +288607,261 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "https://github.com/octocat/Hello-World"
]
},
- "invitation_teams_url": {
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "https://api.github.com/repos/octocat/Hello-World"
]
},
- "invitation_source": {
+ "archive_url": {
"type": "string",
"examples": [
- "\"member\""
+ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
]
- }
- },
- "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": {
- "type": [
- "string",
- "null"
+ },
+ "assignees_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
]
},
- "email": {
- "type": [
- "string",
- "null"
+ "blobs_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
]
},
- "login": {
+ "branches_url": {
"type": "string",
"examples": [
- "octocat"
+ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
]
},
- "id": {
- "type": "integer",
- "format": "int64",
+ "collaborators_url": {
+ "type": "string",
"examples": [
- 1
+ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
]
},
- "node_id": {
+ "comments_url": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
+ "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
]
},
- "avatar_url": {
+ "commits_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ ]
+ },
+ "compare_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ ]
+ },
+ "contents_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ ]
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/images/error/octocat_happy.gif"
+ "http://api.github.com/repos/octocat/Hello-World/contributors"
]
},
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
"examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "http://api.github.com/repos/octocat/Hello-World/deployments"
]
},
- "url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/downloads"
]
},
- "html_url": {
+ "events_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/events"
]
},
- "followers_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "http://api.github.com/repos/octocat/Hello-World/forks"
]
},
- "following_url": {
+ "git_commits_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
]
},
- "gists_url": {
+ "git_refs_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
]
},
- "starred_url": {
+ "git_tags_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
]
},
- "subscriptions_url": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ ]
+ },
+ "issue_events_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ ]
+ },
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ ]
+ },
+ "keys_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ ]
+ },
+ "labels_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ ]
+ },
+ "languages_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "http://api.github.com/repos/octocat/Hello-World/languages"
]
},
- "organizations_url": {
+ "merges_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "http://api.github.com/repos/octocat/Hello-World/merges"
]
},
- "repos_url": {
+ "milestones_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ ]
+ },
+ "notifications_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ ]
+ },
+ "pulls_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "http://api.github.com/repos/octocat/Hello-World/stargazers"
]
},
- "events_url": {
+ "statuses_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
]
},
- "received_events_url": {
+ "subscribers_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "http://api.github.com/repos/octocat/Hello-World/subscribers"
]
},
- "type": {
+ "subscription_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "User"
+ "http://api.github.com/repos/octocat/Hello-World/subscription"
]
},
- "site_admin": {
- "type": "boolean"
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/tags"
+ ]
},
- "starred_at": {
+ "teams_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ "http://api.github.com/repos/octocat/Hello-World/teams"
]
},
- "user_view_type": {
+ "trees_url": {
"type": "string",
"examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "examples": [
- 1296269
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Hello-World"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "This your first repo!"
- ]
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/repos/octocat/Hello-World"
- ]
- },
- "archive_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- ]
- },
- "assignees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- ]
- },
- "blobs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- ]
- },
- "branches_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- ]
- },
- "collaborators_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- ]
- },
- "comments_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- ]
- },
- "commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- ]
- },
- "compare_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- ]
- },
- "contents_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- ]
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contributors"
- ]
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/deployments"
- ]
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/downloads"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/events"
- ]
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/forks"
- ]
- },
- "git_commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- ]
- },
- "git_refs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- ]
- },
- "git_tags_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- ]
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- ]
- },
- "issue_events_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- ]
- },
- "keys_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- ]
- },
- "labels_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- ]
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/languages"
- ]
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/merges"
- ]
- },
- "milestones_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- ]
- },
- "notifications_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- ]
- },
- "pulls_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- ]
- },
- "releases_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- ]
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
- ]
- },
- "statuses_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- ]
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
- ]
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscription"
- ]
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/tags"
- ]
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/teams"
- ]
- },
- "trees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
]
},
"clone_url": {
@@ -696060,3011 +694111,331 @@
"schema": {
"type": "string",
"enum": [
- "followers",
- "repositories",
- "joined"
- ]
- }
- },
- {
- "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 is ignored unless you provide `sort`.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "desc",
- "asc"
- ],
- "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": "object",
- "required": [
- "total_count",
- "incomplete_results",
- "items"
- ],
- "properties": {
- "total_count": {
- "type": "integer"
- },
- "incomplete_results": {
- "type": "boolean"
- },
- "items": {
- "type": "array",
- "items": {
- "title": "User Search Result Item",
- "description": "User Search Result Item",
- "type": "object",
- "properties": {
- "login": {
- "type": "string"
- },
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "node_id": {
- "type": "string"
- },
- "avatar_url": {
- "type": "string",
- "format": "uri"
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- },
- "followers_url": {
- "type": "string",
- "format": "uri"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri"
- },
- "repos_url": {
- "type": "string",
- "format": "uri"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri"
- },
- "type": {
- "type": "string"
- },
- "score": {
- "type": "number"
- },
- "following_url": {
- "type": "string"
- },
- "gists_url": {
- "type": "string"
- },
- "starred_url": {
- "type": "string"
- },
- "events_url": {
- "type": "string"
- },
- "public_repos": {
- "type": "integer"
- },
- "public_gists": {
- "type": "integer"
- },
- "followers": {
- "type": "integer"
- },
- "following": {
- "type": "integer"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "bio": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email"
- },
- "location": {
- "type": [
- "string",
- "null"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "hireable": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "type": [
- "string",
- "null"
- ]
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "blog": {
- "type": [
- "string",
- "null"
- ]
- },
- "company": {
- "type": [
- "string",
- "null"
- ]
- },
- "suspended_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "user_view_type": {
- "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",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 12,
- "incomplete_results": false,
- "items": [
- {
- "login": "mojombo",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
- "gravatar_id": "",
- "url": "https://api.github.com/users/mojombo",
- "html_url": "https://github.com/mojombo",
- "followers_url": "https://api.github.com/users/mojombo/followers",
- "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
- "organizations_url": "https://api.github.com/users/mojombo/orgs",
- "repos_url": "https://api.github.com/users/mojombo/repos",
- "received_events_url": "https://api.github.com/users/mojombo/received_events",
- "type": "User",
- "score": 1,
- "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
- "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
- "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
- "site_admin": true
- }
- ]
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "503": {
- "description": "Service unavailable",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/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-cloud@latest//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-cloud@latest//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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
- }
- },
- "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-cloud@latest//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-cloud@latest//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",
- "null"
- ],
- "description": "The ID of a team to set as the parent team."
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
+ "followers",
+ "repositories",
+ "joined"
+ ]
}
},
- "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"
- }
- }
- }
- }
+ {
+ "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 is ignored unless you provide `sort`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "desc",
+ "asc"
+ ],
+ "default": "desc"
}
},
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
+ {
+ "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": {
- "title": "Validation Error",
- "description": "Validation Error",
"type": "object",
"required": [
- "message",
- "documentation_url"
+ "total_count",
+ "incomplete_results",
+ "items"
],
"properties": {
- "message": {
- "type": "string"
+ "total_count": {
+ "type": "integer"
},
- "documentation_url": {
- "type": "string"
+ "incomplete_results": {
+ "type": "boolean"
},
- "errors": {
+ "items": {
"type": "array",
"items": {
+ "title": "User Search Result Item",
+ "description": "User Search Result Item",
"type": "object",
- "required": [
- "code"
- ],
"properties": {
- "resource": {
+ "login": {
"type": "string"
},
- "field": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
"type": "string"
},
- "message": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
"type": "string"
},
- "code": {
+ "score": {
+ "type": "number"
+ },
+ "following_url": {
"type": "string"
},
- "index": {
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "public_repos": {
"type": "integer"
},
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "bio": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email"
+ },
+ "location": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "hireable": {
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
"type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
}
}
+ }
+ },
+ "blog": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "company": {
+ "type": [
+ "string",
+ "null"
]
+ },
+ "suspended_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
+ },
+ "user_view_type": {
+ "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",
+ "score"
+ ]
}
}
}
- }
- }
- }
- },
- "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"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 12,
+ "incomplete_results": false,
+ "items": [
+ {
+ "login": "mojombo",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/mojombo",
+ "html_url": "https://github.com/mojombo",
+ "followers_url": "https://api.github.com/users/mojombo/followers",
+ "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
+ "organizations_url": "https://api.github.com/users/mojombo/orgs",
+ "repos_url": "https://api.github.com/users/mojombo/repos",
+ "received_events_url": "https://api.github.com/users/mojombo/received_events",
+ "type": "User",
+ "score": 1,
+ "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
+ "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
+ "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
+ "site_admin": true
+ }
+ ]
}
}
}
}
}
- }
- },
- "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-cloud@latest//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-cloud@latest//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",
+ "304": {
+ "description": "Not modified"
+ },
+ "503": {
+ "description": "Service unavailable",
"content": {
"application/json": {
"schema": {
- "title": "Basic Error",
- "description": "Basic Error",
"type": "object",
"properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
+ "code": {
"type": "string"
},
- "url": {
+ "message": {
"type": "string"
},
- "status": {
+ "documentation_url": {
"type": "string"
}
}
@@ -699151,25 +694522,22 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
+ "category": "search",
+ "subcategory": "search"
+ }
}
},
- "/teams/{team_id}/discussions": {
+ "/teams/{team_id}": {
"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-cloud@latest//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.",
+ "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-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-legacy",
+ "operationId": "teams/get-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
},
"parameters": [
{
@@ -699180,38 +694548,6 @@
"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": {
@@ -699220,545 +694556,115 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -699766,403 +694672,684 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
+ "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"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"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.",
+ },
+ "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-cloud@latest//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/get-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -700173,58 +695360,189 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "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",
+ "null"
+ ],
+ "description": "The ID of a team to set as the parent team."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Response",
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -700232,489 +695550,751 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
+ "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/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": {
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -700722,378 +696302,763 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "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": {
@@ -701102,20 +697067,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-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.",
+ "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-cloud@latest//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-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -701126,20 +697091,112 @@
"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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -701148,22 +697205,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-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.",
+ "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-cloud@latest//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-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -701175,15 +697232,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.",
@@ -701225,8 +697273,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": {
@@ -701405,16 +697453,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -701428,7 +697476,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -701438,45 +697486,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -701536,10 +697605,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -701569,19 +697641,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,
@@ -701614,20 +697689,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": [
{
@@ -701638,15 +697713,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -701656,19 +697722,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."
}
}
}
@@ -701681,8 +697758,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": {
@@ -701861,16 +697938,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -701884,7 +697961,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -701894,45 +697971,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -701992,10 +698090,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702023,19 +698124,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,
@@ -702060,22 +698164,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": [
{
@@ -702095,15 +698199,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -702112,8 +698207,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": {
@@ -702292,16 +698387,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -702315,7 +698410,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -702325,45 +698420,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -702423,10 +698539,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702454,19 +698573,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,
@@ -702490,20 +698612,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": [
{
@@ -702523,37 +698645,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"
}
}
}
@@ -702566,8 +698680,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": {
@@ -702746,16 +698860,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -702769,7 +698883,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -702779,45 +698893,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -702877,10 +699012,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -702908,19 +699046,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,
@@ -702944,20 +699085,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": [
{
@@ -702977,15 +699118,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -702999,7 +699131,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml
index 263898764..adf6872a3 100644
--- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml
+++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml
@@ -1079,7 +1079,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:
- - &732
+ - &729
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1808,7 +1808,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &742
+ schema: &739
title: Scim Error
description: Scim Error
type: object
@@ -9260,7 +9260,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &743
+ '401': &740
description: Authorization failure
'404': *6
x-github:
@@ -13533,7 +13533,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &517
+ instances_url: &514
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13569,7 +13569,7 @@ paths:
format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissed_reason: &518
+ dismissed_reason: &515
type:
- string
- 'null'
@@ -13580,14 +13580,14 @@ paths:
- won't fix
- used in tests
-
- dismissed_comment: &519
+ dismissed_comment: &516
type:
- string
- 'null'
description: The dismissal comment associated with the dismissal
of the alert.
maxLength: 280
- rule: &520
+ rule: &517
type: object
properties:
id:
@@ -13648,7 +13648,7 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: &521
+ tool: &518
type: object
properties:
name: *109
@@ -13659,26 +13659,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *110
- most_recent_instance: &522
+ most_recent_instance: &519
type: object
properties:
- ref: &515
+ ref: &512
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &532
+ analysis_key: &529
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: &533
+ environment: &530
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: &534
+ category: &531
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13692,7 +13692,7 @@ paths:
properties:
text:
type: string
- location: &535
+ location: &532
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13713,7 +13713,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: &536
+ items: &533
type:
- string
- 'null'
@@ -17487,7 +17487,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
- - &573
+ - &570
name: has
in: query
description: |-
@@ -17604,7 +17604,7 @@ paths:
- direct
- transitive
-
- security_advisory: &574
+ security_advisory: &571
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17840,7 +17840,7 @@ paths:
dismissal.
maxLength: 280
fixed_at: *133
- auto_dismissed_at: &575
+ auto_dismissed_at: &572
type:
- string
- 'null'
@@ -17848,7 +17848,7 @@ paths:
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissal_request: &576
+ dismissal_request: &573
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -21392,7 +21392,7 @@ paths:
- object
rules:
type: array
- items: &698
+ items: &695
title: Repository Rule
type: object
description: A repository rule.
@@ -21401,7 +21401,7 @@ paths:
- *164
- *165
- *166
- - &696
+ - &693
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21961,14 +21961,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &710
+ state: &707
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: &711
+ resolution: &708
type:
- string
- 'null'
@@ -22075,14 +22075,14 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - &712
+ - &709
description: 'Details on the location where the token was
initially detected. This can be a commit, wiki commit, issue,
discussion, pull request.
'
oneOf:
- - &714
+ - &711
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -22139,7 +22139,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &715
+ - &712
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.
@@ -22200,7 +22200,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &716
+ - &713
description: Represents an 'issue_title' secret scanning
location type. This location type shows that a secret
was detected in the title of an issue.
@@ -22215,7 +22215,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &717
+ - &714
description: Represents an 'issue_body' secret scanning
location type. This location type shows that a secret
was detected in the body of an issue.
@@ -22230,7 +22230,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &718
+ - &715
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on an issue.
@@ -22245,7 +22245,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &719
+ - &716
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret
was detected in the title of a discussion.
@@ -22260,7 +22260,7 @@ paths:
- https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &720
+ - &717
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret
was detected in the body of a discussion.
@@ -22275,7 +22275,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &721
+ - &718
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret
was detected in a comment on a discussion.
@@ -22290,7 +22290,7 @@ paths:
- https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &722
+ - &719
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.
@@ -22305,7 +22305,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &723
+ - &720
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.
@@ -22320,7 +22320,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &724
+ - &721
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.
@@ -22335,7 +22335,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &725
+ - &722
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.
@@ -22350,7 +22350,7 @@ paths:
- https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &726
+ - &723
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
@@ -25692,7 +25692,7 @@ paths:
properties:
action:
type: string
- discussion: &851
+ discussion: &846
title: Discussion
description: A Discussion in a repository.
type: object
@@ -26478,7 +26478,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &770
+ sub_issues_summary: &767
title: Sub-issues Summary
type: object
properties:
@@ -26499,7 +26499,7 @@ paths:
- string
- 'null'
format: uri
- issue_dependencies_summary: &771
+ issue_dependencies_summary: &768
title: Issue Dependencies Summary
type: object
properties:
@@ -26518,7 +26518,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &772
+ items: &769
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -26631,7 +26631,7 @@ paths:
action:
type: string
issue: *212
- comment: &633
+ comment: &630
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -27354,7 +27354,7 @@ paths:
type: string
release:
allOf:
- - &689
+ - &686
title: Release
description: A release.
type: object
@@ -27436,7 +27436,7 @@ paths:
author: *4
assets:
type: array
- items: &690
+ items: &687
title: Release Asset
description: Data related to a release.
type: object
@@ -28027,7 +28027,7 @@ paths:
url:
type: string
format: uri
- user: &782
+ user: &777
title: Public User
description: Public User
type: object
@@ -31384,14 +31384,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:
- - &444
+ - &441
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &445
+ - &442
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -31453,7 +31453,7 @@ paths:
'404': *6
'403': *27
'304': *35
- '301': &450
+ '301': &447
description: Moved permanently
content:
application/json:
@@ -31475,7 +31475,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &663
+ - &660
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -31483,7 +31483,7 @@ paths:
schema:
type: boolean
default: false
- - &664
+ - &661
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -31493,7 +31493,7 @@ paths:
type: boolean
default: false
- *218
- - &665
+ - &662
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:
@@ -32037,7 +32037,7 @@ paths:
- url
- subscription_url
examples:
- default: &666
+ default: &663
value:
- id: '1'
repository:
@@ -33166,7 +33166,7 @@ paths:
type: array
items: *149
examples:
- default: &672
+ default: &669
value:
- property_name: environment
value: production
@@ -33216,7 +33216,7 @@ paths:
required:
- properties
examples:
- default: &673
+ default: &670
value:
properties:
- property_name: environment
@@ -34107,7 +34107,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &457
+ items: &454
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -36230,7 +36230,7 @@ paths:
type: array
items: *272
examples:
- default: &785
+ default: &780
value:
total_count: 1
repositories:
@@ -37274,7 +37274,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -37309,7 +37309,7 @@ paths:
- key_id
- key
examples:
- default: &478
+ default: &475
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -37722,7 +37722,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *85
- - &462
+ - &459
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)."
@@ -38961,12 +38961,12 @@ paths:
required:
- subject_digests
examples:
- default: &812
+ default: &807
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &813
+ withPredicateType: &808
value:
subject_digests:
- sha256:abc123
@@ -39025,7 +39025,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &814
+ default: &809
value:
attestations_subject_digests:
- sha256:abc:
@@ -39374,7 +39374,7 @@ paths:
initiator:
type: string
examples:
- default: &491
+ default: &488
value:
attestations:
- bundle:
@@ -40296,7 +40296,7 @@ paths:
be returned.
in: query
required: false
- schema: &516
+ schema: &513
type: string
description: Severity of a code scanning alert.
enum:
@@ -41355,7 +41355,7 @@ paths:
machine:
anyOf:
- type: 'null'
- - &548
+ - &545
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
@@ -42307,7 +42307,7 @@ paths:
- updated_at
- visibility
examples:
- default: &549
+ default: &546
value:
total_count: 2
secrets:
@@ -42345,7 +42345,7 @@ paths:
description: Response
content:
application/json:
- schema: &550
+ schema: &547
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -42380,7 +42380,7 @@ paths:
- key_id
- key
examples:
- default: &551
+ default: &548
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -42412,7 +42412,7 @@ paths:
application/json:
schema: *316
examples:
- default: &553
+ default: &550
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -44291,7 +44291,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -44310,7 +44310,7 @@ paths:
- key_id
- key
examples:
- default: &580
+ default: &577
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -44640,7 +44640,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *85
- - &588
+ - &585
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -44648,7 +44648,7 @@ paths:
required: false
schema:
type: string
- - &589
+ - &586
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -44656,7 +44656,7 @@ paths:
required: false
schema:
type: string
- - &590
+ - &587
name: time_period
description: |-
The time period to filter by.
@@ -44672,7 +44672,7 @@ paths:
- week
- month
default: month
- - &591
+ - &588
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -44697,7 +44697,7 @@ paths:
application/json:
schema:
type: array
- items: &592
+ items: &589
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -44860,7 +44860,7 @@ paths:
examples:
- https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &593
+ default: &590
value:
- id: 21
number: 42
@@ -44978,7 +44978,7 @@ paths:
application/json:
schema:
type: array
- items: &594
+ items: &591
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -45101,7 +45101,7 @@ paths:
examples:
- https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &595
+ default: &592
value:
- id: 21
number: 42
@@ -45203,7 +45203,7 @@ paths:
application/json:
schema:
type: array
- items: &596
+ items: &593
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -45330,7 +45330,7 @@ paths:
examples:
- https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &597
+ default: &594
value:
- id: 21
number: 42
@@ -45676,7 +45676,7 @@ paths:
description: Response
content:
application/json:
- schema: &441
+ schema: &438
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -45766,7 +45766,7 @@ paths:
member_name: Octo Lisa
member_email: octo_lisa@github.com
examples:
- default: &442
+ default: &439
value:
group_id: '123'
group_name: Octocat admins
@@ -45821,7 +45821,7 @@ paths:
description: Response
content:
application/json:
- schema: &439
+ schema: &436
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -45861,7 +45861,7 @@ paths:
group_name: group-azuread-test2
updated_at: 2021-06-03 22:27:15:000 -700
examples:
- default: &440
+ default: &437
value:
groups:
- group_id: '123'
@@ -47190,7 +47190,7 @@ paths:
application/json:
schema: *20
examples:
- default: &628
+ default: &625
value:
id: 1
account:
@@ -47418,7 +47418,7 @@ paths:
required: true
content:
application/json:
- schema: &629
+ schema: &626
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -48286,7 +48286,7 @@ paths:
application/json:
schema: *363
examples:
- default: &547
+ default: &544
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -49548,7 +49548,7 @@ paths:
parameters:
- *85
- *369
- - &797
+ - &792
name: repo_name
description: repo_name parameter
in: path
@@ -50894,7 +50894,7 @@ paths:
- nuget
- container
- *85
- - &798
+ - &793
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -50935,7 +50935,7 @@ paths:
default: *374
'403': *27
'401': *23
- '400': &800
+ '400': &795
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -52761,7 +52761,7 @@ paths:
latest_status_update:
anyOf:
- type: 'null'
- - &884
+ - &879
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -53035,7 +53035,7 @@ paths:
content:
oneOf:
- *212
- - &562
+ - &559
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -53280,7 +53280,7 @@ paths:
- review_comment
- self
author_association: *213
- auto_merge: &675
+ auto_merge: &672
title: Auto merge
description: The status of auto merging a pull request.
type:
@@ -53662,7 +53662,7 @@ paths:
- updated_at
- project_url
examples:
- default: &817
+ default: &812
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53839,7 +53839,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &818
+ items: &813
type: object
properties:
name:
@@ -53875,7 +53875,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &819
+ iteration_configuration: &814
type: object
description: The configuration for iteration fields.
properties:
@@ -53924,7 +53924,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &820
+ single_select_field: &815
summary: Create a single select field
value:
name: Priority
@@ -53951,7 +53951,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &821
+ iteration_field: &816
summary: Create an iteration field
value:
name: Sprint
@@ -53977,7 +53977,7 @@ paths:
application/json:
schema: *394
examples:
- text_field: &822
+ text_field: &817
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -53986,7 +53986,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: &823
+ number_field: &818
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -53995,7 +53995,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: &824
+ date_field: &819
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -54004,7 +54004,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: &825
+ single_select_field: &820
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -54038,7 +54038,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &826
+ iteration_field: &821
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -54084,7 +54084,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *391
- - &827
+ - &822
name: field_id
description: The unique identifier of the field.
in: path
@@ -54099,7 +54099,7 @@ paths:
application/json:
schema: *394
examples:
- default: &828
+ default: &823
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -55232,7 +55232,7 @@ paths:
parameters:
- *391
- *85
- - &829
+ - &824
name: view_number
description: The number that identifies the project view.
in: path
@@ -56002,7 +56002,7 @@ paths:
description: Response
content:
application/json:
- schema: &449
+ schema: &446
title: Full Repository
description: Full Repository
type: object
@@ -56467,7 +56467,7 @@ paths:
description: Whether anonymous git access is allowed.
default: true
type: boolean
- code_of_conduct: &567
+ code_of_conduct: &564
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
@@ -56581,7 +56581,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &451
+ default: &448
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -57134,7 +57134,7 @@ paths:
- *85
- *17
- *19
- - &697
+ - &694
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -57350,7 +57350,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *85
- - &699
+ - &696
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
@@ -57362,14 +57362,14 @@ paths:
x-multi-segment: true
- *298
- *103
- - &700
+ - &697
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
- - &701
+ - &698
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -57389,7 +57389,7 @@ paths:
description: Response
content:
application/json:
- schema: &702
+ schema: &699
title: Rule Suites
description: Response
type: array
@@ -57445,7 +57445,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &703
+ default: &700
value:
- id: 21
actor_id: 12
@@ -57489,7 +57489,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *85
- - &704
+ - &701
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -57505,7 +57505,7 @@ paths:
description: Response
content:
application/json:
- schema: &705
+ schema: &702
title: Rule Suite
description: Response
type: object
@@ -57612,7 +57612,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &706
+ default: &703
value:
id: 21
actor_id: 12
@@ -57944,7 +57944,7 @@ paths:
- *108
- *19
- *17
- - &708
+ - &705
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
@@ -57954,7 +57954,7 @@ paths:
required: false
schema:
type: string
- - &709
+ - &706
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
@@ -58167,7 +58167,7 @@ paths:
application/json:
schema:
type: array
- items: &730
+ items: &727
description: A repository security advisory.
type: object
properties:
@@ -58486,7 +58486,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &731
+ default: &728
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -59497,7 +59497,7 @@ paths:
description: Response
content:
application/json:
- schema: &446
+ schema: &443
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -59549,7 +59549,7 @@ paths:
group_description: Another group of Developers working on AzureAD
SAML SSO
examples:
- default: &447
+ default: &444
value:
groups:
- group_id: '123'
@@ -60425,15 +60425,6 @@ paths:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -60496,8 +60487,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -60510,7 +60499,7 @@ paths:
- updated_at
- url
examples:
- default: &774
+ default: &771
value:
- author:
login: octocat
@@ -60535,8 +60524,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
@@ -60646,8 +60633,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
@@ -60758,7 +60743,7 @@ paths:
application/json:
schema: *433
examples:
- default: &775
+ default: &772
value:
author:
login: octocat
@@ -60783,8 +60768,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
@@ -60839,418 +60822,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:
- - *85
- - *209
- - *435
- - *108
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &436
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- anyOf:
- - type: 'null'
- - *4
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *214
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &776
- 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: *45
- 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:
- - *85
- - *209
- - *435
- 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: *436
- examples:
- default: &437
- 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:
- - *85
- - *209
- - *435
- - &438
- 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: *436
- examples:
- default: *437
- 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:
- - *85
- - *209
- - *435
- - *438
- 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: *436
- examples:
- default: &777
- 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:
- - *85
- - *209
- - *435
- - *438
- 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
@@ -61272,9 +60843,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -61318,9 +60889,9 @@ paths:
description: Response
content:
application/json:
- schema: *441
+ schema: *438
examples:
- default: *442
+ default: *439
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -61461,7 +61032,7 @@ paths:
description: Response
content:
application/json:
- schema: &443
+ schema: &440
title: Team Membership
description: Team Membership
type: object
@@ -61489,7 +61060,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &778
+ response-if-user-is-a-team-maintainer: &773
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -61552,9 +61123,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-users-membership-with-team-is-now-pending: &779
+ response-if-users-membership-with-team-is-now-pending: &774
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -61661,14 +61232,14 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &780
+ schema: &775
title: Team Repository
description: A team's access to a repository.
type: object
@@ -62311,8 +61882,8 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -62359,8 +61930,8 @@ paths:
parameters:
- *85
- *209
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -62393,9 +61964,9 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
- default: *447
+ default: *444
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -62461,7 +62032,7 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -62506,7 +62077,7 @@ paths:
type: array
items: *301
examples:
- response-if-child-teams-exist: &781
+ response-if-child-teams-exist: &776
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -62660,7 +62231,7 @@ paths:
resources:
type: object
properties:
- core: &448
+ core: &445
title: Rate Limit
type: object
properties:
@@ -62677,21 +62248,21 @@ paths:
- remaining
- reset
- used
- graphql: *448
- search: *448
- code_search: *448
- source_import: *448
- integration_manifest: *448
- code_scanning_upload: *448
- actions_runner_registration: *448
- scim: *448
- dependency_snapshots: *448
- dependency_sbom: *448
- code_scanning_autofix: *448
+ graphql: *445
+ search: *445
+ code_search: *445
+ source_import: *445
+ integration_manifest: *445
+ code_scanning_upload: *445
+ actions_runner_registration: *445
+ scim: *445
+ dependency_snapshots: *445
+ dependency_sbom: *445
+ code_scanning_autofix: *445
required:
- core
- search
- rate: *448
+ rate: *445
required:
- rate
- resources
@@ -62796,14 +62367,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default-response:
summary: Default response
@@ -63308,7 +62879,7 @@ paths:
status: disabled
'403': *27
'404': *6
- '301': *450
+ '301': *447
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63326,8 +62897,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -63585,10 +63156,10 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
- '307': &452
+ default: *448
+ '307': &449
description: Temporary Redirect
content:
application/json:
@@ -63617,8 +63188,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -63640,7 +63211,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
- '307': *452
+ '307': *449
'404': *6
'409': *116
x-github:
@@ -63664,11 +63235,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- - &469
+ - &466
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -63691,7 +63262,7 @@ paths:
type: integer
artifacts:
type: array
- items: &453
+ items: &450
title: Artifact
description: An artifact
type: object
@@ -63786,7 +63357,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &470
+ default: &467
value:
total_count: 2
artifacts:
@@ -63847,9 +63418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *444
- - *445
- - &454
+ - *441
+ - *442
+ - &451
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -63861,7 +63432,7 @@ paths:
description: Response
content:
application/json:
- schema: *453
+ schema: *450
examples:
default:
value:
@@ -63899,9 +63470,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *444
- - *445
- - *454
+ - *441
+ - *442
+ - *451
responses:
'204':
description: Response
@@ -63925,9 +63496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *444
- - *445
- - *454
+ - *441
+ - *442
+ - *451
- name: archive_format
in: path
required: true
@@ -63941,7 +63512,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': &632
+ '410': &629
description: Gone
content:
application/json:
@@ -63966,14 +63537,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &455
+ schema: &452
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -64007,13 +63578,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *455
+ schema: *452
examples:
selected_actions: *42
responses:
@@ -64042,14 +63613,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -64083,13 +63654,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *456
+ schema: *453
examples:
selected_actions: *44
responses:
@@ -64120,14 +63691,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
default:
value:
@@ -64153,11 +63724,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:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- - &458
+ - &455
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
@@ -64191,7 +63762,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: Repository actions caches
description: Repository actions caches
type: object
@@ -64241,7 +63812,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &460
+ default: &457
value:
total_count: 1
actions_caches:
@@ -64273,23 +63844,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:
- - *444
- - *445
+ - *441
+ - *442
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *458
+ - *455
responses:
'200':
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64309,8 +63880,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:
- - *444
- - *445
+ - *441
+ - *442
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -64341,9 +63912,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:
- - *444
- - *445
- - &461
+ - *441
+ - *442
+ - &458
name: job_id
description: The unique identifier of the job.
in: path
@@ -64355,7 +63926,7 @@ paths:
description: Response
content:
application/json:
- schema: &473
+ schema: &470
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -64702,9 +64273,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:
- - *444
- - *445
- - *461
+ - *441
+ - *442
+ - *458
responses:
'302':
description: Response
@@ -64732,9 +64303,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:
- - *444
- - *445
- - *461
+ - *441
+ - *442
+ - *458
requestBody:
required: false
content:
@@ -64780,8 +64351,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Status response
@@ -64831,8 +64402,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -64895,8 +64466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -64914,7 +64485,7 @@ paths:
type: integer
secrets:
type: array
- items: &475
+ items: &472
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -64935,7 +64506,7 @@ paths:
- created_at
- updated_at
examples:
- default: &476
+ default: &473
value:
total_count: 2
secrets:
@@ -64968,9 +64539,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *444
- - *445
- - *462
+ - *441
+ - *442
+ - *459
- *19
responses:
'200':
@@ -64987,7 +64558,7 @@ paths:
type: integer
variables:
type: array
- items: &479
+ items: &476
title: Actions Variable
type: object
properties:
@@ -65021,7 +64592,7 @@ paths:
- created_at
- updated_at
examples:
- default: &480
+ default: &477
value:
total_count: 2
variables:
@@ -65054,8 +64625,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65064,7 +64635,7 @@ paths:
schema:
type: object
properties:
- enabled: &463
+ enabled: &460
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *58
@@ -65099,8 +64670,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65111,7 +64682,7 @@ paths:
schema:
type: object
properties:
- enabled: *463
+ enabled: *460
allowed_actions: *58
sha_pinning_required: *59
required:
@@ -65144,14 +64715,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &464
+ schema: &461
type: object
properties:
access_level:
@@ -65169,7 +64740,7 @@ paths:
required:
- access_level
examples:
- default: &465
+ default: &462
value:
access_level: organization
x-github:
@@ -65194,15 +64765,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
responses:
'204':
description: Response
@@ -65226,8 +64797,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65257,8 +64828,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Empty response for successful settings update
@@ -65292,8 +64863,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65320,8 +64891,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65355,8 +64926,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65384,8 +64955,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -65416,8 +64987,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65448,8 +65019,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -65481,8 +65052,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65511,8 +65082,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Success response
@@ -65552,8 +65123,8 @@ paths:
in: query
schema:
type: string
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -65597,8 +65168,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -65630,8 +65201,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -65705,8 +65276,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -65742,8 +65313,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -65773,8 +65344,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200':
@@ -65804,8 +65375,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'204':
@@ -65832,8 +65403,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200': *79
@@ -65858,8 +65429,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
requestBody:
required: true
@@ -65908,8 +65479,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
requestBody:
required: true
@@ -65959,8 +65530,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
responses:
'200': *279
@@ -65990,8 +65561,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:
- - *444
- - *445
+ - *441
+ - *442
- *73
- *280
responses:
@@ -66021,9 +65592,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:
- - *444
- - *445
- - &483
+ - *441
+ - *442
+ - &480
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.
@@ -66031,7 +65602,7 @@ paths:
required: false
schema:
type: string
- - &484
+ - &481
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -66039,7 +65610,7 @@ paths:
required: false
schema:
type: string
- - &485
+ - &482
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -66048,7 +65619,7 @@ paths:
required: false
schema:
type: string
- - &486
+ - &483
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
@@ -66075,7 +65646,7 @@ paths:
- pending
- *17
- *19
- - &487
+ - &484
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)."
@@ -66084,7 +65655,7 @@ paths:
schema:
type: string
format: date-time
- - &466
+ - &463
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -66093,13 +65664,13 @@ paths:
schema:
type: boolean
default: false
- - &488
+ - &485
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &489
+ - &486
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -66122,7 +65693,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &467
+ items: &464
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -66300,7 +65871,7 @@ paths:
head_commit:
anyOf:
- type: 'null'
- - &511
+ - &508
title: Simple Commit
description: A commit.
type: object
@@ -66415,7 +65986,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &490
+ default: &487
value:
total_count: 1
workflow_runs:
@@ -66651,24 +66222,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *444
- - *445
- - &468
+ - *441
+ - *442
+ - &465
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *466
+ - *463
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: &471
+ default: &468
value:
id: 30433642
name: Build
@@ -66909,9 +66480,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'204':
description: Response
@@ -66934,9 +66505,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -67064,9 +66635,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'201':
description: Response
@@ -67099,12 +66670,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
- *17
- *19
- - *469
+ - *466
responses:
'200':
description: Response
@@ -67120,9 +66691,9 @@ paths:
type: integer
artifacts:
type: array
- items: *453
+ items: *450
examples:
- default: *470
+ default: *467
headers:
Link: *45
x-github:
@@ -67146,25 +66717,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *444
- - *445
- - *468
- - &472
+ - *441
+ - *442
+ - *465
+ - &469
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *466
+ - *463
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *471
+ default: *468
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67187,10 +66758,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:
- - *444
- - *445
- - *468
- - *472
+ - *441
+ - *442
+ - *465
+ - *469
- *17
- *19
responses:
@@ -67208,9 +66779,9 @@ paths:
type: integer
jobs:
type: array
- items: *473
+ items: *470
examples:
- default: &474
+ default: &471
value:
total_count: 1
jobs:
@@ -67323,10 +66894,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *444
- - *445
- - *468
- - *472
+ - *441
+ - *442
+ - *465
+ - *469
responses:
'302':
description: Response
@@ -67354,9 +66925,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'202':
description: Response
@@ -67389,9 +66960,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: true
content:
@@ -67458,9 +67029,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'202':
description: Response
@@ -67493,9 +67064,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
- 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
@@ -67525,9 +67096,9 @@ paths:
type: integer
jobs:
type: array
- items: *473
+ items: *470
examples:
- default: *474
+ default: *471
headers:
Link: *45
x-github:
@@ -67552,9 +67123,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'302':
description: Response
@@ -67581,9 +67152,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'204':
description: Response
@@ -67610,9 +67181,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -67681,7 +67252,7 @@ paths:
items:
type: object
properties:
- type: &598
+ type: &595
type: string
description: The type of reviewer.
enum:
@@ -67767,9 +67338,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: true
content:
@@ -67819,7 +67390,7 @@ paths:
application/json:
schema:
type: array
- items: &583
+ items: &580
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -67931,7 +67502,7 @@ paths:
- created_at
- updated_at
examples:
- default: &584
+ default: &581
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -67987,9 +67558,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: false
content:
@@ -68034,9 +67605,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:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
requestBody:
required: false
content:
@@ -68091,9 +67662,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *444
- - *445
- - *468
+ - *441
+ - *442
+ - *465
responses:
'200':
description: Response
@@ -68230,8 +67801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -68249,9 +67820,9 @@ paths:
type: integer
secrets:
type: array
- items: *475
+ items: *472
examples:
- default: *476
+ default: *473
headers:
Link: *45
x-github:
@@ -68276,16 +67847,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68307,17 +67878,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
- default: &611
+ default: &608
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -68343,8 +67914,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -68402,8 +67973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -68429,9 +68000,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *444
- - *445
- - *462
+ - *441
+ - *442
+ - *459
- *19
responses:
'200':
@@ -68448,9 +68019,9 @@ paths:
type: integer
variables:
type: array
- items: *479
+ items: *476
examples:
- default: *480
+ default: *477
headers:
Link: *45
x-github:
@@ -68473,8 +68044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -68526,17 +68097,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
responses:
'200':
description: Response
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: &612
+ default: &609
value:
name: USERNAME
value: octocat
@@ -68562,8 +68133,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
requestBody:
required: true
@@ -68606,8 +68177,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
responses:
'204':
@@ -68633,8 +68204,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -68652,7 +68223,7 @@ paths:
type: integer
workflows:
type: array
- items: &481
+ items: &478
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -68770,9 +68341,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *444
- - *445
- - &482
+ - *441
+ - *442
+ - &479
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -68787,7 +68358,7 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
default:
value:
@@ -68820,9 +68391,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68847,9 +68418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68900,9 +68471,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'204':
description: Response
@@ -68929,19 +68500,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:
- - *444
- - *445
+ - *441
+ - *442
+ - *479
+ - *480
+ - *481
- *482
- *483
+ - *17
+ - *19
- *484
+ - *463
- *485
- *486
- - *17
- - *19
- - *487
- - *466
- - *488
- - *489
responses:
'200':
description: Response
@@ -68957,9 +68528,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *467
+ items: *464
examples:
- default: *490
+ default: *487
headers:
Link: *45
x-github:
@@ -68992,9 +68563,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *444
- - *445
- - *482
+ - *441
+ - *442
+ - *479
responses:
'200':
description: Response
@@ -69055,8 +68626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *108
- *17
- *106
@@ -69224,8 +68795,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -69262,8 +68833,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:
- - *444
- - *445
+ - *441
+ - *442
- name: assignee
in: path
required: true
@@ -69299,8 +68870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -69412,8 +68983,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *106
- *107
@@ -69470,7 +69041,7 @@ paths:
initiator:
type: string
examples:
- default: *491
+ default: *488
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69490,8 +69061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -69499,7 +69070,7 @@ paths:
application/json:
schema:
type: array
- items: &492
+ items: &489
title: Autolink reference
description: An autolink reference.
type: object
@@ -69558,8 +69129,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -69598,9 +69169,9 @@ paths:
description: response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: &493
+ default: &490
value:
id: 1
key_prefix: TICKET-
@@ -69631,9 +69202,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:
- - *444
- - *445
- - &494
+ - *441
+ - *442
+ - &491
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -69645,9 +69216,9 @@ paths:
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
'404': *6
x-github:
githubCloudOnly: false
@@ -69667,9 +69238,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:
- - *444
- - *445
- - *494
+ - *441
+ - *442
+ - *491
responses:
'204':
description: Response
@@ -69693,8 +69264,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response if Dependabot is enabled
@@ -69744,8 +69315,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -69766,8 +69337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -69787,8 +69358,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -69826,7 +69397,7 @@ paths:
- url
protected:
type: boolean
- protection: &496
+ protection: &493
title: Branch Protection
description: Branch Protection
type: object
@@ -69869,7 +69440,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &499
+ enforce_admins: &496
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -69886,7 +69457,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &501
+ required_pull_request_reviews: &498
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -69970,7 +69541,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &498
+ restrictions: &495
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -70263,9 +69834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *444
- - *445
- - &497
+ - *441
+ - *442
+ - &494
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).
@@ -70279,14 +69850,14 @@ paths:
description: Response
content:
application/json:
- schema: &507
+ schema: &504
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &558
+ commit: &555
title: Commit
description: Commit
type: object
@@ -70325,7 +69896,7 @@ paths:
author:
anyOf:
- type: 'null'
- - &495
+ - &492
title: Git User
description: Metaproperties for Git author/committer
information.
@@ -70347,7 +69918,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
message:
type: string
examples:
@@ -70371,7 +69942,7 @@ paths:
required:
- sha
- url
- verification: &618
+ verification: &615
title: Verification
type: object
properties:
@@ -70451,7 +70022,7 @@ paths:
type: integer
files:
type: array
- items: &569
+ items: &566
title: Diff Entry
description: Diff Entry
type: object
@@ -70547,7 +70118,7 @@ paths:
- self
protected:
type: boolean
- protection: *496
+ protection: *493
protection_url:
type: string
format: uri
@@ -70656,7 +70227,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *450
+ '301': *447
'404': *6
x-github:
githubCloudOnly: false
@@ -70678,15 +70249,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
default:
value:
@@ -70880,9 +70451,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -71142,7 +70713,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &504
+ required_status_checks: &501
title: Status Check Policy
description: Status Check Policy
type: object
@@ -71301,7 +70872,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *498
+ restrictions: *495
required_conversation_resolution:
type: object
properties:
@@ -71413,9 +70984,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71440,17 +71011,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &500
+ default: &497
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -71472,17 +71043,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71501,9 +71072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71528,17 +71099,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: &502
+ default: &499
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -71634,9 +71205,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -71734,9 +71305,9 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: *502
+ default: *499
'422': *15
x-github:
githubCloudOnly: false
@@ -71757,9 +71328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71786,17 +71357,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: &503
+ default: &500
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -71819,17 +71390,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *503
+ default: *500
'404': *6
x-github:
githubCloudOnly: false
@@ -71849,9 +71420,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -71876,17 +71447,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: &505
+ default: &502
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -71912,9 +71483,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -71966,9 +71537,9 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: *505
+ default: *502
'404': *6
'422': *15
x-github:
@@ -71990,9 +71561,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -72016,9 +71587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72052,9 +71623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72121,9 +71692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72187,9 +71758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
content:
application/json:
@@ -72255,15 +71826,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
default:
value:
@@ -72354,9 +71925,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'204':
description: Response
@@ -72379,9 +71950,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72391,7 +71962,7 @@ paths:
type: array
items: *5
examples:
- default: &506
+ default: &503
value:
- id: 1
slug: octoapp
@@ -72448,9 +72019,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72484,7 +72055,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72505,9 +72076,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72541,7 +72112,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72562,9 +72133,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72598,7 +72169,7 @@ paths:
type: array
items: *5
examples:
- default: *506
+ default: *503
'422': *15
x-github:
githubCloudOnly: false
@@ -72620,9 +72191,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72652,9 +72223,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72713,9 +72284,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: false
content:
@@ -72774,9 +72345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
content:
application/json:
@@ -72835,9 +72406,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:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
responses:
'200':
description: Response
@@ -72871,9 +72442,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72931,9 +72502,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -72991,9 +72562,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -73053,9 +72624,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
requestBody:
required: true
content:
@@ -73077,7 +72648,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
default:
value:
@@ -73191,8 +72762,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -73228,8 +72799,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73302,8 +72873,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -73343,8 +72914,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73414,8 +72985,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_request_number
in: path
required: true
@@ -73486,8 +73057,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: bypass_response_id
in: path
required: true
@@ -73520,8 +73091,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -73800,7 +73371,7 @@ paths:
description: Response
content:
application/json:
- schema: &508
+ schema: &505
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -73936,7 +73507,7 @@ paths:
check.
type: array
items: *216
- deployment: &840
+ deployment: &835
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -74223,9 +73794,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *444
- - *445
- - &509
+ - *441
+ - *442
+ - &506
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -74237,9 +73808,9 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
- default: &510
+ default: &507
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -74339,9 +73910,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
requestBody:
required: true
content:
@@ -74581,9 +74152,9 @@ paths:
description: Response
content:
application/json:
- schema: *508
+ schema: *505
examples:
- default: *510
+ default: *507
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74603,9 +74174,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
- *17
- *19
responses:
@@ -74715,9 +74286,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *444
- - *445
- - *509
+ - *441
+ - *442
+ - *506
responses:
'201':
description: Response
@@ -74761,8 +74332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -74784,7 +74355,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &512
+ schema: &509
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -74882,7 +74453,7 @@ paths:
- string
- 'null'
format: date-time
- head_commit: *511
+ head_commit: *508
latest_check_runs_count:
type: integer
check_runs_url:
@@ -74910,7 +74481,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &513
+ default: &510
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -75201,9 +74772,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *512
+ schema: *509
examples:
- default: *513
+ default: *510
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75222,8 +74793,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -75532,9 +75103,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *444
- - *445
- - &514
+ - *441
+ - *442
+ - &511
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -75546,9 +75117,9 @@ paths:
description: Response
content:
application/json:
- schema: *512
+ schema: *509
examples:
- default: *513
+ default: *510
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75571,17 +75142,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:
- - *444
- - *445
- - *514
- - &564
+ - *441
+ - *442
+ - *511
+ - &561
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &565
+ - &562
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -75620,9 +75191,9 @@ paths:
type: integer
check_runs:
type: array
- items: *508
+ items: *505
examples:
- default: &566
+ default: &563
value:
total_count: 1
check_runs:
@@ -75724,9 +75295,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *444
- - *445
- - *514
+ - *441
+ - *442
+ - *511
responses:
'201':
description: Response
@@ -75759,21 +75330,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:
- - *444
- - *445
+ - *441
+ - *442
- *305
- *306
- *19
- *17
- - &530
+ - &527
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: *515
- - &531
+ schema: *512
+ - &528
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -75804,7 +75375,7 @@ paths:
be returned.
in: query
required: false
- schema: *516
+ schema: *513
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -75828,7 +75399,7 @@ paths:
updated_at: *131
url: *128
html_url: *129
- instances_url: *517
+ instances_url: *514
state: *111
fixed_at: *133
dismissed_by:
@@ -75836,11 +75407,11 @@ paths:
- type: 'null'
- *4
dismissed_at: *132
- dismissed_reason: *518
- dismissed_comment: *519
- rule: *520
- tool: *521
- most_recent_instance: *522
+ dismissed_reason: *515
+ dismissed_comment: *516
+ rule: *517
+ tool: *518
+ most_recent_instance: *519
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -75963,7 +75534,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *35
- '403': &523
+ '403': &520
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -75990,9 +75561,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:
- - *444
- - *445
- - &524
+ - *441
+ - *442
+ - &521
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -76006,7 +75577,7 @@ paths:
description: Response
content:
application/json:
- schema: &525
+ schema: &522
type: object
properties:
number: *123
@@ -76014,7 +75585,7 @@ paths:
updated_at: *131
url: *128
html_url: *129
- instances_url: *517
+ instances_url: *514
state: *111
fixed_at: *133
dismissed_by:
@@ -76022,8 +75593,8 @@ paths:
- type: 'null'
- *4
dismissed_at: *132
- dismissed_reason: *518
- dismissed_comment: *519
+ dismissed_reason: *515
+ dismissed_comment: *516
rule:
type: object
properties:
@@ -76085,8 +75656,8 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: *521
- most_recent_instance: *522
+ tool: *518
+ most_recent_instance: *519
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -76182,7 +75753,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *35
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76202,9 +75773,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: true
content:
@@ -76219,8 +75790,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *518
- dismissed_comment: *519
+ dismissed_reason: *515
+ dismissed_comment: *516
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -76248,7 +75819,7 @@ paths:
description: Response
content:
application/json:
- schema: *525
+ schema: *522
examples:
default:
value:
@@ -76324,7 +75895,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &529
+ '403': &526
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -76351,15 +75922,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
responses:
'200':
description: Response
content:
application/json:
- schema: &526
+ schema: &523
type: object
properties:
status:
@@ -76386,13 +75957,13 @@ paths:
- description
- started_at
examples:
- default: &527
+ default: &524
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &528
+ '400': &525
description: Bad Request
content:
application/json:
@@ -76403,7 +75974,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': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76428,29 +75999,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
responses:
'200':
description: OK
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: *527
+ default: *524
'202':
description: Accepted
content:
application/json:
- schema: *526
+ schema: *523
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *528
+ '400': *525
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -76482,9 +76053,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: false
content:
@@ -76530,8 +76101,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *528
- '403': *529
+ '400': *525
+ '403': *526
'404': *6
'422':
description: Unprocessable Entity
@@ -76555,13 +76126,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *19
- *17
- - *530
- - *531
+ - *527
+ - *528
responses:
'200':
description: Response
@@ -76572,10 +76143,10 @@ paths:
items:
type: object
properties:
- ref: *515
- analysis_key: *532
- environment: *533
- category: *534
+ ref: *512
+ analysis_key: *529
+ environment: *530
+ category: *531
state:
type:
- string
@@ -76592,7 +76163,7 @@ paths:
properties:
text:
type: string
- location: *535
+ location: *532
html_url:
type: string
classifications:
@@ -76600,7 +76171,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: *536
+ items: *533
examples:
default:
value:
@@ -76639,7 +76210,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76673,25 +76244,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:
- - *444
- - *445
+ - *441
+ - *442
- *305
- *306
- *19
- *17
- - *531
+ - *528
- 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: *515
+ schema: *512
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &537
+ schema: &534
type: string
description: An identifier for the upload.
examples:
@@ -76713,23 +76284,23 @@ paths:
application/json:
schema:
type: array
- items: &538
+ items: &535
type: object
properties:
- ref: *515
- commit_sha: &546
+ ref: *512
+ commit_sha: &543
description: The SHA of the commit to which the analysis you
are uploading relates.
type: string
minLength: 40
maxLength: 40
pattern: "^[0-9a-fA-F]+$"
- analysis_key: *532
+ analysis_key: *529
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *534
+ category: *531
error:
type: string
examples:
@@ -76754,8 +76325,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *537
- tool: *521
+ sarif_id: *534
+ tool: *518
deletable:
type: boolean
warning:
@@ -76817,7 +76388,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -76853,8 +76424,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:
- - *444
- - *445
+ - *441
+ - *442
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -76867,7 +76438,7 @@ paths:
description: Response
content:
application/json:
- schema: *538
+ schema: *535
examples:
response:
summary: application/json response
@@ -76921,7 +76492,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *523
+ '403': *520
'404': *6
'422':
description: Response if analysis could not be processed
@@ -77008,8 +76579,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:
- - *444
- - *445
+ - *441
+ - *442
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -77065,7 +76636,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': *529
+ '403': *526
'404': *6
'503': *189
x-github:
@@ -77087,8 +76658,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -77096,7 +76667,7 @@ paths:
application/json:
schema:
type: array
- items: &539
+ items: &536
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -77208,7 +76779,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': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -77237,8 +76808,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:
- - *444
- - *445
+ - *441
+ - *442
- name: language
in: path
description: The language of the CodeQL database.
@@ -77250,7 +76821,7 @@ paths:
description: Response
content:
application/json:
- schema: *539
+ schema: *536
examples:
default:
value:
@@ -77282,9 +76853,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': &571
+ '302': &568
description: Found
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -77306,8 +76877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: language
in: path
description: The language of the CodeQL database.
@@ -77317,7 +76888,7 @@ paths:
responses:
'204':
description: Response
- '403': *529
+ '403': *526
'404': *6
'503': *189
x-github:
@@ -77345,8 +76916,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -77355,7 +76926,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &540
+ language: &537
type: string
description: The language targeted by the CodeQL query
enum:
@@ -77435,7 +77006,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &544
+ schema: &541
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -77445,7 +77016,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *117
actor: *4
- query_language: *540
+ query_language: *537
query_pack_url:
type: string
description: The download url for the query pack.
@@ -77493,7 +77064,7 @@ paths:
items:
type: object
properties:
- repository: &541
+ repository: &538
title: Repository Identifier
description: Repository Identifier
type: object
@@ -77535,7 +77106,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &545
+ analysis_status: &542
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -77567,7 +77138,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &542
+ access_mismatch_repos: &539
type: object
properties:
repository_count:
@@ -77582,7 +77153,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: *541
+ items: *538
required:
- repository_count
- repositories
@@ -77605,8 +77176,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *542
- over_limit_repos: *542
+ no_codeql_db_repos: *539
+ over_limit_repos: *539
required:
- access_mismatch_repos
- not_found_repos
@@ -77622,7 +77193,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &543
+ value: &540
summary: Default response
value:
id: 1
@@ -77768,10 +77339,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *543
+ value: *540
repository_lists:
summary: Response for a successful variant analysis submission
- value: *543
+ value: *540
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -77799,8 +77370,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:
- - *444
- - *445
+ - *441
+ - *442
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -77812,9 +77383,9 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
- default: *543
+ default: *540
'404': *6
'503': *189
x-github:
@@ -77837,7 +77408,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:
- - *444
+ - *441
- name: repo
in: path
description: The name of the controller repository.
@@ -77872,7 +77443,7 @@ paths:
type: object
properties:
repository: *117
- analysis_status: *545
+ analysis_status: *542
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -77997,8 +77568,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78091,7 +77662,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *523
+ '403': *520
'404': *6
'503': *189
x-github:
@@ -78112,8 +77683,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -78207,7 +77778,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *529
+ '403': *526
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -78278,8 +77849,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -78287,7 +77858,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *546
+ commit_sha: *543
ref:
type: string
description: |-
@@ -78347,7 +77918,7 @@ paths:
schema:
type: object
properties:
- id: *537
+ id: *534
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -78361,7 +77932,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': *529
+ '403': *526
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -78384,8 +77955,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:
- - *444
- - *445
+ - *441
+ - *442
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -78433,7 +78004,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': *523
+ '403': *520
'404':
description: Not Found if the sarif id does not match any upload
'503': *189
@@ -78458,8 +78029,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78540,8 +78111,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -78669,8 +78240,8 @@ paths:
parameters:
- *17
- *19
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -78984,8 +78555,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -79051,7 +78622,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -79059,7 +78630,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'400': *14
'401': *23
'403': *27
@@ -79088,8 +78659,8 @@ paths:
parameters:
- *17
- *19
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -79153,8 +78724,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:
- - *444
- - *445
+ - *441
+ - *442
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -79191,9 +78762,9 @@ paths:
type: integer
machines:
type: array
- items: *548
+ items: *545
examples:
- default: &788
+ default: &783
value:
total_count: 2
machines:
@@ -79233,8 +78804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -79321,8 +78892,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:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -79391,8 +78962,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -79410,7 +78981,7 @@ paths:
type: integer
secrets:
type: array
- items: &552
+ items: &549
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -79431,7 +79002,7 @@ paths:
- created_at
- updated_at
examples:
- default: *549
+ default: *546
headers:
Link: *45
x-github:
@@ -79454,16 +79025,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *550
+ schema: *547
examples:
- default: *551
+ default: *548
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -79483,17 +79054,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *552
+ schema: *549
examples:
- default: *553
+ default: *550
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79513,8 +79084,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:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -79567,8 +79138,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -79597,8 +79168,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -79636,7 +79207,7 @@ paths:
application/json:
schema:
type: array
- items: &554
+ items: &551
title: Collaborator
description: Collaborator
type: object
@@ -79829,8 +79400,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:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'204':
@@ -79877,8 +79448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
requestBody:
required: false
@@ -79905,7 +79476,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &631
+ schema: &628
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -80133,8 +79704,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'204':
@@ -80166,8 +79737,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *136
responses:
'200':
@@ -80188,7 +79759,7 @@ paths:
user:
anyOf:
- type: 'null'
- - *554
+ - *551
required:
- permission
- role_name
@@ -80242,8 +79813,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -80253,7 +79824,7 @@ paths:
application/json:
schema:
type: array
- items: &555
+ items: &552
title: Commit Comment
description: Commit Comment
type: object
@@ -80311,7 +79882,7 @@ paths:
- created_at
- updated_at
examples:
- default: &560
+ default: &557
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -80370,17 +79941,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: &561
+ default: &558
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -80437,8 +80008,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -80461,7 +80032,7 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
default:
value:
@@ -80512,8 +80083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -80535,8 +80106,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -80563,7 +80134,7 @@ paths:
application/json:
schema:
type: array
- items: &556
+ items: &553
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -80607,7 +80178,7 @@ paths:
- content
- created_at
examples:
- default: &635
+ default: &632
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -80652,8 +80223,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -80686,9 +80257,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: &557
+ default: &554
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -80717,9 +80288,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -80741,10 +80312,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - &636
+ - &633
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -80799,8 +80370,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -80856,9 +80427,9 @@ paths:
application/json:
schema:
type: array
- items: *558
+ items: *555
examples:
- default: &682
+ default: &679
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -80952,9 +80523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *444
- - *445
- - &559
+ - *441
+ - *442
+ - &556
name: commit_sha
description: The SHA of the commit.
in: path
@@ -81026,9 +80597,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
- *17
- *19
responses:
@@ -81038,9 +80609,9 @@ paths:
application/json:
schema:
type: array
- items: *555
+ items: *552
examples:
- default: *560
+ default: *557
headers:
Link: *45
x-github:
@@ -81068,9 +80639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
requestBody:
required: true
content:
@@ -81105,9 +80676,9 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
- default: *561
+ default: *558
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -81135,9 +80706,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:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
- *17
- *19
responses:
@@ -81147,9 +80718,9 @@ paths:
application/json:
schema:
type: array
- items: *562
+ items: *559
examples:
- default: &674
+ default: &671
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -81686,11 +81257,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
- - &563
+ - &560
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)"
@@ -81705,9 +81276,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: &660
+ default: &657
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -81820,11 +81391,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:
- - *444
- - *445
- - *563
- - *564
- - *565
+ - *441
+ - *442
+ - *560
+ - *561
+ - *562
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -81858,9 +81429,9 @@ paths:
type: integer
check_runs:
type: array
- items: *508
+ items: *505
examples:
- default: *566
+ default: *563
headers:
Link: *45
x-github:
@@ -81885,9 +81456,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:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -81895,7 +81466,7 @@ paths:
schema:
type: integer
example: 1
- - *564
+ - *561
- *17
- *19
responses:
@@ -81913,7 +81484,7 @@ paths:
type: integer
check_suites:
type: array
- items: *512
+ items: *509
examples:
default:
value:
@@ -82113,9 +81684,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:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- *17
- *19
responses:
@@ -82317,9 +81888,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *444
- - *445
- - *563
+ - *441
+ - *442
+ - *560
- *17
- *19
responses:
@@ -82329,7 +81900,7 @@ paths:
application/json:
schema:
type: array
- items: &735
+ items: &732
title: Status
description: The status of a commit.
type: object
@@ -82410,7 +81981,7 @@ paths:
site_admin: false
headers:
Link: *45
- '301': *450
+ '301': *447
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82438,8 +82009,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -82472,11 +82043,11 @@ paths:
code_of_conduct:
anyOf:
- type: 'null'
- - *567
+ - *564
code_of_conduct_file:
anyOf:
- type: 'null'
- - &568
+ - &565
title: Community Health File
type: object
properties:
@@ -82496,19 +82067,19 @@ paths:
contributing:
anyOf:
- type: 'null'
- - *568
+ - *565
readme:
anyOf:
- type: 'null'
- - *568
+ - *565
issue_template:
anyOf:
- type: 'null'
- - *568
+ - *565
pull_request_template:
anyOf:
- type: 'null'
- - *568
+ - *565
required:
- code_of_conduct
- code_of_conduct_file
@@ -82637,8 +82208,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
- name: basehead
@@ -82686,8 +82257,8 @@ paths:
format: uri
examples:
- https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *558
- merge_base_commit: *558
+ base_commit: *555
+ merge_base_commit: *555
status:
type: string
enum:
@@ -82711,10 +82282,10 @@ paths:
- 6
commits:
type: array
- items: *558
+ items: *555
files:
type: array
- items: *569
+ items: *566
required:
- url
- html_url
@@ -83000,8 +82571,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -83154,7 +82725,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &570
+ response-if-content-is-a-file: &567
summary: Response if content is a file
value:
type: file
@@ -83291,7 +82862,7 @@ paths:
- size
- type
- url
- - &687
+ - &684
title: Content File
description: Content File
type: object
@@ -83509,7 +83080,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *570
+ response-if-content-is-a-file: *567
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -83578,7 +83149,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *27
- '302': *571
+ '302': *568
'304': *35
x-github:
githubCloudOnly: false
@@ -83601,8 +83172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -83697,7 +83268,7 @@ paths:
description: Response
content:
application/json:
- schema: &572
+ schema: &569
title: File Commit
description: File Commit
type: object
@@ -83853,7 +83424,7 @@ paths:
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
example-for-creating-a-file:
value:
@@ -83907,7 +83478,7 @@ paths:
schema:
oneOf:
- *3
- - &613
+ - &610
description: Repository rule violation was detected
type: object
properties:
@@ -83928,7 +83499,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &727
+ placeholder_id: &724
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -83960,8 +83531,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: path
description: path parameter
in: path
@@ -84022,7 +83593,7 @@ paths:
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
default:
value:
@@ -84077,8 +83648,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -84202,8 +83773,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *321
- *322
- *323
@@ -84215,7 +83786,7 @@ paths:
schema:
type: string
- *325
- - *573
+ - *570
- *326
- *327
- *108
@@ -84236,7 +83807,7 @@ paths:
application/json:
schema:
type: array
- items: &577
+ items: &574
type: object
description: A Dependabot alert.
properties:
@@ -84286,7 +83857,7 @@ paths:
- direct
- transitive
-
- security_advisory: *574
+ security_advisory: *571
security_vulnerability: *127
url: *128
html_url: *129
@@ -84317,8 +83888,8 @@ paths:
dismissal.
maxLength: 280
fixed_at: *133
- auto_dismissed_at: *575
- dismissal_request: *576
+ auto_dismissed_at: *572
+ dismissal_request: *573
required:
- number
- state
@@ -84548,9 +84119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *444
- - *445
- - &578
+ - *441
+ - *442
+ - &575
name: alert_number
in: path
description: |-
@@ -84565,7 +84136,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -84678,9 +84249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *444
- - *445
- - *578
+ - *441
+ - *442
+ - *575
requestBody:
required: true
content:
@@ -84725,7 +84296,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -84854,8 +84425,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -84873,7 +84444,7 @@ paths:
type: integer
secrets:
type: array
- items: &581
+ items: &578
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -84927,16 +84498,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84956,15 +84527,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -84990,8 +84561,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
requestBody:
required: true
@@ -85044,8 +84615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *282
responses:
'204':
@@ -85068,8 +84639,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:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -85243,8 +84814,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -85504,8 +85075,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -85588,7 +85159,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &582
+ metadata: &579
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -85627,7 +85198,7 @@ paths:
examples:
- "/src/build/package-lock.json"
additionalProperties: false
- metadata: *582
+ metadata: *579
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -85641,7 +85212,7 @@ paths:
pattern: "^pkg"
examples:
- pkg:/npm/%40actions/http-client@1.0.11
- metadata: *582
+ metadata: *579
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -85774,8 +85345,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -85816,9 +85387,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: *584
+ default: *581
headers:
Link: *45
x-github:
@@ -85884,8 +85455,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -85967,7 +85538,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
simple-example:
summary: Simple example
@@ -86040,9 +85611,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *444
- - *445
- - &585
+ - *441
+ - *442
+ - &582
name: deployment_id
description: deployment_id parameter
in: path
@@ -86054,7 +85625,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -86119,9 +85690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
responses:
'204':
description: Response
@@ -86143,9 +85714,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
- *17
- *19
responses:
@@ -86155,7 +85726,7 @@ paths:
application/json:
schema:
type: array
- items: &586
+ items: &583
title: Deployment Status
description: The status of a deployment.
type: object
@@ -86319,9 +85890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
requestBody:
required: true
content:
@@ -86396,9 +85967,9 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *583
examples:
- default: &587
+ default: &584
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -86454,9 +86025,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *444
- - *445
- - *585
+ - *441
+ - *442
+ - *582
- name: status_id
in: path
required: true
@@ -86467,9 +86038,9 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *583
examples:
- default: *587
+ default: *584
'404': *6
x-github:
githubCloudOnly: false
@@ -86496,12 +86067,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
+ - *585
+ - *586
+ - *587
- *588
- - *589
- - *590
- - *591
- *17
- *19
responses:
@@ -86511,9 +86082,9 @@ paths:
application/json:
schema:
type: array
- items: *592
+ items: *589
examples:
- default: *593
+ default: *590
'404': *6
'403': *27
'500': *38
@@ -86537,8 +86108,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86550,7 +86121,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *592
+ schema: *589
examples:
default:
value:
@@ -86606,8 +86177,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86666,12 +86237,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
+ - *585
+ - *586
+ - *587
- *588
- - *589
- - *590
- - *591
- *17
- *19
responses:
@@ -86681,9 +86252,9 @@ paths:
application/json:
schema:
type: array
- items: *594
+ items: *591
examples:
- default: *595
+ default: *592
'404': *6
'403': *27
'500': *38
@@ -86707,8 +86278,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86720,7 +86291,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *594
+ schema: *591
examples:
default:
value:
@@ -86771,8 +86342,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86810,7 +86381,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *594
+ schema: *591
examples:
default:
value:
@@ -86861,8 +86432,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86933,8 +86504,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -86967,8 +86538,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *101
- *102
- *103
@@ -86982,9 +86553,9 @@ paths:
application/json:
schema:
type: array
- items: *596
+ items: *593
examples:
- default: *597
+ default: *594
'404': *6
'403': *27
'500': *38
@@ -87009,8 +86580,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -87022,7 +86593,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *596
+ schema: *593
examples:
default:
value:
@@ -87080,8 +86651,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: alert_number
in: path
required: true
@@ -87150,8 +86721,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -87208,8 +86779,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -87227,7 +86798,7 @@ paths:
- 5
environments:
type: array
- items: &599
+ items: &596
title: Environment
description: Details of a deployment environment
type: object
@@ -87289,7 +86860,7 @@ paths:
type: string
examples:
- wait_timer
- wait_timer: &601
+ wait_timer: &598
type: integer
description: The amount of time to delay a job after
the job is initially triggered. The time (in minutes)
@@ -87331,7 +86902,7 @@ paths:
items:
type: object
properties:
- type: *598
+ type: *595
reviewer:
anyOf:
- *4
@@ -87358,7 +86929,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &602
+ deployment_branch_policy: &599
type:
- object
- 'null'
@@ -87475,9 +87046,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *444
- - *445
- - &600
+ - *441
+ - *442
+ - &597
name: environment_name
in: path
required: true
@@ -87490,9 +87061,9 @@ paths:
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: &603
+ default: &600
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -87576,9 +87147,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: false
content:
@@ -87588,7 +87159,7 @@ paths:
- object
- 'null'
properties:
- wait_timer: *601
+ wait_timer: *598
prevent_self_review:
type: boolean
description: Whether or not a user who created the job is prevented
@@ -87607,14 +87178,14 @@ paths:
items:
type: object
properties:
- type: *598
+ type: *595
id:
type: integer
description: The id of the user or team who can review the
deployment
examples:
- 4532992
- deployment_branch_policy: *602
+ deployment_branch_policy: *599
additionalProperties: false
examples:
default:
@@ -87634,9 +87205,9 @@ paths:
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: *603
+ default: *600
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -87660,9 +87231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
responses:
'204':
description: Default response
@@ -87687,9 +87258,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *17
- *19
responses:
@@ -87708,7 +87279,7 @@ paths:
- 2
branch_policies:
type: array
- items: &604
+ items: &601
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -87769,9 +87340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: true
content:
@@ -87819,9 +87390,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- example-wildcard: &605
+ example-wildcard: &602
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -87863,10 +87434,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - &606
+ - *441
+ - *442
+ - *597
+ - &603
name: branch_policy_id
in: path
required: true
@@ -87878,9 +87449,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87899,10 +87470,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - *606
+ - *441
+ - *442
+ - *597
+ - *603
requestBody:
required: true
content:
@@ -87931,9 +87502,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -87952,10 +87523,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *444
- - *445
- - *600
- - *606
+ - *441
+ - *442
+ - *597
+ - *603
responses:
'204':
description: Response
@@ -87980,9 +87551,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
responses:
'200':
description: List of deployment protection rules
@@ -87999,7 +87570,7 @@ paths:
- 10
custom_deployment_protection_rules:
type: array
- items: &607
+ items: &604
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -88021,7 +87592,7 @@ paths:
for the environment.
examples:
- true
- app: &608
+ app: &605
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -88124,9 +87695,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
requestBody:
content:
application/json:
@@ -88147,9 +87718,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: &609
+ default: &606
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -88184,9 +87755,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:
- - *600
- - *445
- - *444
+ - *597
+ - *442
+ - *441
- *19
- *17
responses:
@@ -88206,7 +87777,7 @@ paths:
- 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *608
+ items: *605
examples:
default:
value:
@@ -88241,10 +87812,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:
- - *444
- - *445
- - *600
- - &610
+ - *441
+ - *442
+ - *597
+ - &607
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -88256,9 +87827,9 @@ paths:
description: Response
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: *609
+ default: *606
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88279,10 +87850,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:
- - *600
- - *445
- - *444
- - *610
+ - *597
+ - *442
+ - *441
+ - *607
responses:
'204':
description: Response
@@ -88308,9 +87879,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *17
- *19
responses:
@@ -88328,9 +87899,9 @@ paths:
type: integer
secrets:
type: array
- items: *475
+ items: *472
examples:
- default: *476
+ default: *473
headers:
Link: *45
x-github:
@@ -88355,17 +87926,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88387,18 +87958,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
- default: *611
+ default: *608
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88420,9 +87991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
requestBody:
required: true
@@ -88480,9 +88051,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *282
responses:
'204':
@@ -88508,10 +88079,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *444
- - *445
- - *600
- - *462
+ - *441
+ - *442
+ - *597
+ - *459
- *19
responses:
'200':
@@ -88528,9 +88099,9 @@ paths:
type: integer
variables:
type: array
- items: *479
+ items: *476
examples:
- default: *480
+ default: *477
headers:
Link: *45
x-github:
@@ -88553,9 +88124,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
requestBody:
required: true
content:
@@ -88607,18 +88178,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *444
- - *445
- - *600
+ - *441
+ - *442
+ - *597
- *285
responses:
'200':
description: Response
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: *612
+ default: *609
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88639,10 +88210,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
- - *600
+ - *597
requestBody:
required: true
content:
@@ -88684,10 +88255,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *285
- - *600
+ - *597
responses:
'204':
description: Response
@@ -88709,8 +88280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -88778,8 +88349,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -88938,8 +88509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -88972,9 +88543,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
'400': *14
'422': *15
'403': *27
@@ -88995,8 +88566,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89056,7 +88627,7 @@ paths:
schema:
oneOf:
- *247
- - *613
+ - *610
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89081,8 +88652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: file_sha
in: path
required: true
@@ -89182,8 +88753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89292,7 +88863,7 @@ paths:
description: Response
content:
application/json:
- schema: &614
+ schema: &611
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -89519,15 +89090,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *444
- - *445
- - *559
+ - *441
+ - *442
+ - *556
responses:
'200':
description: Response
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -89583,9 +89154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *444
- - *445
- - &615
+ - *441
+ - *442
+ - &612
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.
@@ -89602,7 +89173,7 @@ paths:
application/json:
schema:
type: array
- items: &616
+ items: &613
title: Git Reference
description: Git references within a repository
type: object
@@ -89678,17 +89249,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
responses:
'200':
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: &617
+ default: &614
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -89717,8 +89288,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89747,9 +89318,9 @@ paths:
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: *617
+ default: *614
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -89775,9 +89346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
requestBody:
required: true
content:
@@ -89806,9 +89377,9 @@ paths:
description: Response
content:
application/json:
- schema: *616
+ schema: *613
examples:
- default: *617
+ default: *614
'422': *15
'409': *116
x-github:
@@ -89826,9 +89397,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *444
- - *445
- - *615
+ - *441
+ - *442
+ - *612
responses:
'204':
description: Response
@@ -89883,8 +89454,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -89951,7 +89522,7 @@ paths:
description: Response
content:
application/json:
- schema: &619
+ schema: &616
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -90007,7 +89578,7 @@ paths:
- sha
- type
- url
- verification: *618
+ verification: *615
required:
- sha
- url
@@ -90017,7 +89588,7 @@ paths:
- tag
- message
examples:
- default: &620
+ default: &617
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -90090,8 +89661,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tag_sha
in: path
required: true
@@ -90102,9 +89673,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *620
+ default: *617
'404': *6
'409': *116
x-github:
@@ -90128,8 +89699,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -90203,7 +89774,7 @@ paths:
description: Response
content:
application/json:
- schema: &621
+ schema: &618
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -90305,8 +89876,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -90329,7 +89900,7 @@ paths:
description: Response
content:
application/json:
- schema: *621
+ schema: *618
examples:
default-response:
summary: Default response
@@ -90388,8 +89959,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -90399,7 +89970,7 @@ paths:
application/json:
schema:
type: array
- items: &622
+ items: &619
title: Webhook
description: Webhooks for repositories.
type: object
@@ -90462,7 +90033,7 @@ paths:
format: uri
examples:
- https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &876
+ last_response: &871
title: Hook Response
type: object
properties:
@@ -90539,8 +90110,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -90593,9 +90164,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: &623
+ default: &620
value:
type: Repository
id: 12345678
@@ -90643,17 +90214,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'200':
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *623
+ default: *620
'404': *6
x-github:
githubCloudOnly: false
@@ -90673,8 +90244,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
requestBody:
required: true
@@ -90720,9 +90291,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *623
+ default: *620
'422': *15
'404': *6
x-github:
@@ -90743,8 +90314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90769,8 +90340,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'200':
@@ -90798,8 +90369,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
requestBody:
required: false
@@ -90844,8 +90415,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *17
- *336
@@ -90877,8 +90448,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *16
responses:
@@ -90907,8 +90478,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:
- - *444
- - *445
+ - *441
+ - *442
- *335
- *16
responses:
@@ -90932,8 +90503,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90959,8 +90530,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *335
responses:
'204':
@@ -90984,8 +90555,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response if immutable releases are enabled
@@ -91033,8 +90604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'409': *116
@@ -91054,8 +90625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'409': *116
@@ -91112,14 +90683,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &624
+ schema: &621
title: Import
description: A repository import from an external source.
type: object
@@ -91226,7 +90797,7 @@ paths:
- html_url
- authors_url
examples:
- default: &627
+ default: &624
value:
vcs: subversion
use_lfs: true
@@ -91242,7 +90813,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': &625
+ '503': &622
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -91271,8 +90842,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -91320,7 +90891,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
default:
value:
@@ -91345,7 +90916,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91373,8 +90944,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -91426,7 +90997,7 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
example-1:
summary: Example 1
@@ -91474,7 +91045,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': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91497,12 +91068,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91528,9 +91099,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *444
- - *445
- - &809
+ - *441
+ - *442
+ - &804
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -91544,7 +91115,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
title: Porter Author
description: Porter Author
type: object
@@ -91598,7 +91169,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': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91623,8 +91194,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: author_id
in: path
required: true
@@ -91654,7 +91225,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -91667,7 +91238,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91691,8 +91262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91733,7 +91304,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91761,8 +91332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -91789,11 +91360,11 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *627
+ default: *624
'422': *15
- '503': *625
+ '503': *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91816,8 +91387,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91825,8 +91396,8 @@ paths:
application/json:
schema: *20
examples:
- default: *628
- '301': *450
+ default: *625
+ '301': *447
'404': *6
x-github:
githubCloudOnly: false
@@ -91846,8 +91417,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -91860,7 +91431,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &630
+ default: &627
value:
limit: collaborators_only
origin: repository
@@ -91885,13 +91456,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
application/json:
- schema: *629
+ schema: *626
examples:
default:
summary: Example request body
@@ -91905,7 +91476,7 @@ paths:
application/json:
schema: *353
examples:
- default: *630
+ default: *627
'409':
description: Response
x-github:
@@ -91927,8 +91498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -91951,8 +91522,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -91962,9 +91533,9 @@ paths:
application/json:
schema:
type: array
- items: *631
+ items: *628
examples:
- default: &802
+ default: &797
value:
- id: 1
repository:
@@ -92095,8 +91666,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *357
requestBody:
required: false
@@ -92126,7 +91697,7 @@ paths:
description: Response
content:
application/json:
- schema: *631
+ schema: *628
examples:
default:
value:
@@ -92257,8 +91828,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *357
responses:
'204':
@@ -92290,8 +91861,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *444
- - *445
+ - *441
+ - *442
- 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
@@ -92364,7 +91935,7 @@ paths:
type: array
items: *212
examples:
- default: &641
+ default: &638
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -92512,7 +92083,7 @@ paths:
state_reason: completed
headers:
Link: *45
- '301': *450
+ '301': *447
'422': *15
'404': *6
x-github:
@@ -92541,8 +92112,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -92634,7 +92205,7 @@ paths:
application/json:
schema: *212
examples:
- default: &638
+ default: &635
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -92790,7 +92361,7 @@ paths:
'422': *15
'503': *189
'404': *6
- '410': *632
+ '410': *629
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -92818,8 +92389,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *235
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -92840,9 +92411,9 @@ paths:
application/json:
schema:
type: array
- items: *633
+ items: *630
examples:
- default: &640
+ default: &637
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -92900,17 +92471,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: &634
+ default: &631
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -92964,8 +92535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -92988,9 +92559,9 @@ paths:
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: *634
+ default: *631
'422': *15
x-github:
githubCloudOnly: false
@@ -93008,8 +92579,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -93030,8 +92601,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -93058,9 +92629,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -93081,8 +92652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -93115,16 +92686,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -93146,10 +92717,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - *636
+ - *633
responses:
'204':
description: Response
@@ -93169,8 +92740,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -93180,7 +92751,7 @@ paths:
application/json:
schema:
type: array
- items: &637
+ items: &634
title: Issue Event
description: Issue Event
type: object
@@ -93519,8 +93090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: event_id
in: path
required: true
@@ -93531,7 +93102,7 @@ paths:
description: Response
content:
application/json:
- schema: *637
+ schema: *634
examples:
default:
value:
@@ -93723,7 +93294,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *632
+ '410': *629
'403': *27
x-github:
githubCloudOnly: false
@@ -93757,9 +93328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *444
- - *445
- - &639
+ - *441
+ - *442
+ - &636
name: issue_number
description: The number that identifies the issue.
in: path
@@ -93773,10 +93344,10 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'304': *35
x-github:
githubCloudOnly: false
@@ -93801,9 +93372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -93924,13 +93495,13 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
'422': *15
'503': *189
'403': *27
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93948,9 +93519,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -93978,7 +93549,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93994,9 +93565,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
content:
application/json:
@@ -94023,7 +93594,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94045,9 +93616,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: assignee
in: path
required: true
@@ -94087,9 +93658,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *218
- *17
- *19
@@ -94100,13 +93671,13 @@ paths:
application/json:
schema:
type: array
- items: *633
+ items: *630
examples:
- default: *640
+ default: *637
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94135,9 +93706,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -94159,16 +93730,16 @@ paths:
description: Response
content:
application/json:
- schema: *633
+ schema: *630
examples:
- default: *634
+ default: *631
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -94196,9 +93767,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94210,12 +93781,12 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94243,9 +93814,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -94269,15 +93840,15 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *450
+ '301': *447
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -94308,9 +93879,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -94324,13 +93895,13 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'400': *14
'401': *23
'403': *27
'404': *6
- '410': *632
+ '410': *629
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -94356,9 +93927,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:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94370,12 +93941,12 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94392,9 +93963,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -94408,7 +93979,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &643
+ - &640
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -94457,7 +94028,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &644
+ - &641
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -94585,7 +94156,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &645
+ - &642
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -94631,7 +94202,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &646
+ - &643
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -94677,7 +94248,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &647
+ - &644
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -94726,7 +94297,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &648
+ - &645
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -94768,7 +94339,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &649
+ - &646
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -94810,7 +94381,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &650
+ - &647
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -94866,7 +94437,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &651
+ - &648
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -94911,7 +94482,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &652
+ - &649
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -94972,7 +94543,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &653
+ - &650
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -95033,7 +94604,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &654
+ - &651
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -95094,7 +94665,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &655
+ - &652
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -95187,7 +94758,7 @@ paths:
color: red
headers:
Link: *45
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95204,9 +94775,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95218,7 +94789,7 @@ paths:
type: array
items: *211
examples:
- default: &642
+ default: &639
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -95236,9 +94807,9 @@ paths:
default: false
headers:
Link: *45
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95255,9 +94826,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95318,10 +94889,10 @@ paths:
type: array
items: *211
examples:
- default: *642
- '301': *450
+ default: *639
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'422': *15
x-github:
githubCloudOnly: false
@@ -95338,9 +94909,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95402,10 +94973,10 @@ paths:
type: array
items: *211
examples:
- default: *642
- '301': *450
+ default: *639
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
'422': *15
x-github:
githubCloudOnly: false
@@ -95422,15 +94993,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'204':
description: Response
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95449,9 +95020,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- name: name
in: path
required: true
@@ -95475,9 +95046,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *450
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95497,9 +95068,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: false
content:
@@ -95528,7 +95099,7 @@ paths:
'204':
description: Response
'403': *27
- '410': *632
+ '410': *629
'404': *6
'422': *15
x-github:
@@ -95546,9 +95117,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'204':
description: Response
@@ -95578,9 +95149,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
responses:
'200':
description: Response
@@ -95588,10 +95159,10 @@ paths:
application/json:
schema: *212
examples:
- default: *638
- '301': *450
+ default: *635
+ '301': *447
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95608,9 +95179,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- 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.
@@ -95636,13 +95207,13 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95660,9 +95231,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95694,16 +95265,16 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -95725,10 +95296,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
- *636
+ - *633
responses:
'204':
description: Response
@@ -95757,9 +95328,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95783,7 +95354,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -95816,9 +95387,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95830,11 +95401,11 @@ paths:
type: array
items: *212
examples:
- default: *641
+ default: *638
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95862,9 +95433,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95893,14 +95464,14 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *27
- '410': *632
+ '410': *629
'422': *15
'404': *6
x-github:
@@ -95920,9 +95491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
requestBody:
required: true
content:
@@ -95955,7 +95526,7 @@ paths:
application/json:
schema: *212
examples:
- default: *638
+ default: *635
'403': *27
'404': *6
'422': *7
@@ -95977,9 +95548,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *444
- - *445
- - *639
+ - *441
+ - *442
+ - *636
- *17
- *19
responses:
@@ -95994,6 +95565,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *640
+ - *641
+ - *642
- *643
- *644
- *645
@@ -96004,9 +95578,6 @@ paths:
- *650
- *651
- *652
- - *653
- - *654
- - *655
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -96335,7 +95906,7 @@ paths:
type: string
comments:
type: array
- items: &676
+ items: &673
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -96573,7 +96144,7 @@ paths:
type: string
comments:
type: array
- items: *555
+ items: *552
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -96848,7 +96419,7 @@ paths:
headers:
Link: *45
'404': *6
- '410': *632
+ '410': *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96865,8 +96436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -96876,7 +96447,7 @@ paths:
application/json:
schema:
type: array
- items: &656
+ items: &653
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -96944,8 +96515,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -96981,9 +96552,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: &657
+ default: &654
value:
id: 1
key: ssh-rsa AAA...
@@ -97017,9 +96588,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *444
- - *445
- - &658
+ - *441
+ - *442
+ - &655
name: key_id
description: The unique identifier of the key.
in: path
@@ -97031,9 +96602,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
'404': *6
x-github:
githubCloudOnly: false
@@ -97051,9 +96622,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *444
- - *445
- - *658
+ - *441
+ - *442
+ - *655
responses:
'204':
description: Response
@@ -97073,8 +96644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -97086,7 +96657,7 @@ paths:
type: array
items: *211
examples:
- default: *642
+ default: *639
headers:
Link: *45
'404': *6
@@ -97107,8 +96678,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97146,7 +96717,7 @@ paths:
application/json:
schema: *211
examples:
- default: &659
+ default: &656
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -97178,8 +96749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97192,7 +96763,7 @@ paths:
application/json:
schema: *211
examples:
- default: *659
+ default: *656
'404': *6
x-github:
githubCloudOnly: false
@@ -97209,8 +96780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97275,8 +96846,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: name
in: path
required: true
@@ -97302,8 +96873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -97339,8 +96910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'202': *37
'403':
@@ -97368,8 +96939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -97395,9 +96966,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *444
- - *445
- - *530
+ - *441
+ - *442
+ - *527
responses:
'200':
description: Response
@@ -97544,8 +97115,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97610,8 +97181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97645,9 +97216,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *660
+ default: *657
'204':
description: Response when already merged
'404':
@@ -97672,8 +97243,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -97770,8 +97341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -97813,7 +97384,7 @@ paths:
application/json:
schema: *392
examples:
- default: &661
+ default: &658
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -97872,9 +97443,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *444
- - *445
- - &662
+ - *441
+ - *442
+ - &659
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -97888,7 +97459,7 @@ paths:
application/json:
schema: *392
examples:
- default: *661
+ default: *658
'404': *6
x-github:
githubCloudOnly: false
@@ -97905,9 +97476,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
requestBody:
required: false
content:
@@ -97947,7 +97518,7 @@ paths:
application/json:
schema: *392
examples:
- default: *661
+ default: *658
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -97963,9 +97534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
responses:
'204':
description: Response
@@ -97986,9 +97557,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:
- - *444
- - *445
- - *662
+ - *441
+ - *442
+ - *659
- *17
- *19
responses:
@@ -98000,7 +97571,7 @@ paths:
type: array
items: *211
examples:
- default: *642
+ default: *639
headers:
Link: *45
x-github:
@@ -98019,12 +97590,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:
- - *444
- - *445
- - *663
- - *664
+ - *441
+ - *442
+ - *660
+ - *661
- *218
- - *665
+ - *662
- *17
- *19
responses:
@@ -98036,7 +97607,7 @@ paths:
type: array
items: *238
examples:
- default: *666
+ default: *663
headers:
Link: *45
x-github:
@@ -98060,8 +97631,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -98119,14 +97690,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: &667
+ schema: &664
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -98270,7 +97841,7 @@ paths:
- custom_404
- public
examples:
- default: &668
+ default: &665
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -98311,8 +97882,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98367,9 +97938,9 @@ paths:
description: Response
content:
application/json:
- schema: *667
+ schema: *664
examples:
- default: *668
+ default: *665
'422': *15
'409': *116
x-github:
@@ -98392,8 +97963,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98501,8 +98072,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -98528,8 +98099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -98539,7 +98110,7 @@ paths:
application/json:
schema:
type: array
- items: &669
+ items: &666
title: Page Build
description: Page Build
type: object
@@ -98631,8 +98202,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'201':
description: Response
@@ -98679,16 +98250,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *669
+ schema: *666
examples:
- default: &670
+ default: &667
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -98736,8 +98307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: build_id
in: path
required: true
@@ -98748,9 +98319,9 @@ paths:
description: Response
content:
application/json:
- schema: *669
+ schema: *666
examples:
- default: *670
+ default: *667
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98770,8 +98341,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -98879,9 +98450,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:
- - *444
- - *445
- - &671
+ - *441
+ - *442
+ - &668
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -98939,9 +98510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *444
- - *445
- - *671
+ - *441
+ - *442
+ - *668
responses:
'204': *148
'404': *6
@@ -98968,8 +98539,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -99264,8 +98835,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Private vulnerability reporting status
@@ -99302,8 +98873,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'422': *14
@@ -99324,8 +98895,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204': *148
'422': *14
@@ -99347,8 +98918,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -99358,7 +98929,7 @@ paths:
type: array
items: *149
examples:
- default: *672
+ default: *669
'403': *27
'404': *6
x-github:
@@ -99380,8 +98951,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -99397,7 +98968,7 @@ paths:
required:
- properties
examples:
- default: *673
+ default: *670
responses:
'204':
description: No Content when custom property values are successfully created
@@ -99435,8 +99006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -99496,9 +99067,9 @@ paths:
application/json:
schema:
type: array
- items: *562
+ items: *559
examples:
- default: *674
+ default: *671
headers:
Link: *45
'304': *35
@@ -99530,8 +99101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -99598,7 +99169,7 @@ paths:
description: Response
content:
application/json:
- schema: &678
+ schema: &675
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -99838,7 +99409,7 @@ paths:
- review_comment
- self
author_association: *213
- auto_merge: *675
+ auto_merge: *672
draft:
description: Indicates whether or not the pull request is a draft.
type: boolean
@@ -99940,7 +99511,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &679
+ default: &676
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -100467,8 +100038,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sort
in: query
required: false
@@ -100497,9 +100068,9 @@ paths:
application/json:
schema:
type: array
- items: *676
+ items: *673
examples:
- default: &681
+ default: &678
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -100576,17 +100147,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'200':
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
- default: &677
+ default: &674
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -100661,8 +100232,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -100685,9 +100256,9 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
- default: *677
+ default: *674
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -100703,8 +100274,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
responses:
'204':
@@ -100726,8 +100297,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -100754,9 +100325,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -100777,8 +100348,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:
- - *444
- - *445
+ - *441
+ - *442
- *227
requestBody:
required: true
@@ -100811,16 +100382,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -100842,10 +100413,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *227
- - *636
+ - *633
responses:
'204':
description: Response
@@ -100888,9 +100459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *444
- - *445
- - &680
+ - *441
+ - *442
+ - &677
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -100903,9 +100474,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'304': *35
'404': *6
'406':
@@ -100940,9 +100511,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -100984,9 +100555,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'422': *15
'403': *27
x-github:
@@ -101008,9 +100579,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -101073,7 +100644,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -101081,7 +100652,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -101111,9 +100682,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *235
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -101134,9 +100705,9 @@ paths:
application/json:
schema:
type: array
- items: *676
+ items: *673
examples:
- default: *681
+ default: *678
headers:
Link: *45
x-github:
@@ -101169,9 +100740,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -101277,7 +100848,7 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
example-for-a-multi-line-comment:
value:
@@ -101365,9 +100936,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *227
requestBody:
required: true
@@ -101390,7 +100961,7 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *673
examples:
default:
value:
@@ -101476,9 +101047,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -101488,9 +101059,9 @@ paths:
application/json:
schema:
type: array
- items: *558
+ items: *555
examples:
- default: *682
+ default: *679
headers:
Link: *45
x-github:
@@ -101520,9 +101091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -101532,7 +101103,7 @@ paths:
application/json:
schema:
type: array
- items: *569
+ items: *566
examples:
default:
value:
@@ -101570,9 +101141,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
responses:
'204':
description: Response if pull request has been merged
@@ -101595,9 +101166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -101709,9 +101280,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
responses:
'200':
description: Response
@@ -101786,9 +101357,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -101825,7 +101396,7 @@ paths:
description: Response
content:
application/json:
- schema: *562
+ schema: *559
examples:
default:
value:
@@ -102361,9 +101932,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: true
content:
@@ -102397,7 +101968,7 @@ paths:
description: Response
content:
application/json:
- schema: *562
+ schema: *559
examples:
default:
value:
@@ -102902,9 +102473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
- *17
- *19
responses:
@@ -102914,7 +102485,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &680
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -103070,9 +102641,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:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -103162,9 +102733,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &685
+ default: &682
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -103227,10 +102798,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:
- - *444
- - *445
- - *680
- - &684
+ - *441
+ - *442
+ - *677
+ - &681
name: review_id
description: The unique identifier of the review.
in: path
@@ -103242,9 +102813,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &686
+ default: &683
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -103303,10 +102874,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103329,7 +102900,7 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
default:
value:
@@ -103391,18 +102962,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
responses:
'200':
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *685
+ default: *682
'422': *7
'404': *6
x-github:
@@ -103429,10 +103000,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
- *17
- *19
responses:
@@ -103690,10 +103261,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103722,7 +103293,7 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
default:
value:
@@ -103785,10 +103356,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:
- - *444
- - *445
- - *680
- - *684
+ - *441
+ - *442
+ - *677
+ - *681
requestBody:
required: true
content:
@@ -103823,9 +103394,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *686
+ default: *683
'404': *6
'422': *7
'403': *27
@@ -103847,9 +103418,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *444
- - *445
- - *680
+ - *441
+ - *442
+ - *677
requestBody:
required: false
content:
@@ -103913,8 +103484,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -103927,9 +103498,9 @@ paths:
description: Response
content:
application/json:
- schema: *687
+ schema: *684
examples:
- default: &688
+ default: &685
value:
type: file
encoding: base64
@@ -103971,8 +103542,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:
- - *444
- - *445
+ - *441
+ - *442
- name: dir
description: The alternate path to look for a README file
in: path
@@ -103992,9 +103563,9 @@ paths:
description: Response
content:
application/json:
- schema: *687
+ schema: *684
examples:
- default: *688
+ default: *685
'404': *6
'422': *15
x-github:
@@ -104016,8 +103587,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -104027,7 +103598,7 @@ paths:
application/json:
schema:
type: array
- items: *689
+ items: *686
examples:
default:
value:
@@ -104121,8 +103692,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -104198,9 +103769,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: &693
+ default: &690
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -104305,9 +103876,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *444
- - *445
- - &691
+ - *441
+ - *442
+ - &688
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -104319,9 +103890,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: &692
+ default: &689
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
@@ -104356,7 +103927,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *571
+ '302': *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104372,9 +103943,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *444
- - *445
- - *691
+ - *441
+ - *442
+ - *688
requestBody:
required: false
content:
@@ -104403,9 +103974,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: *692
+ default: *689
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104421,9 +103992,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *444
- - *445
- - *691
+ - *441
+ - *442
+ - *688
responses:
'204':
description: Response
@@ -104447,8 +104018,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -104534,16 +104105,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104560,8 +104131,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: tag
description: tag parameter
in: path
@@ -104574,9 +104145,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'404': *6
x-github:
githubCloudOnly: false
@@ -104598,9 +104169,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *444
- - *445
- - &694
+ - *441
+ - *442
+ - &691
name: release_id
description: The unique identifier of the release.
in: path
@@ -104614,9 +104185,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: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'401':
description: Unauthorized
x-github:
@@ -104634,9 +104205,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
requestBody:
required: false
content:
@@ -104700,9 +104271,9 @@ paths:
description: Response
content:
application/json:
- schema: *689
+ schema: *686
examples:
- default: *693
+ default: *690
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -104723,9 +104294,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
responses:
'204':
description: Response
@@ -104745,9 +104316,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- *17
- *19
responses:
@@ -104757,7 +104328,7 @@ paths:
application/json:
schema:
type: array
- items: *690
+ items: *687
examples:
default:
value:
@@ -104839,9 +104410,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:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- name: name
in: query
required: true
@@ -104867,7 +104438,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *690
+ schema: *687
examples:
response-for-successful-upload:
value:
@@ -104922,9 +104493,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
- 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.
@@ -104948,9 +104519,9 @@ paths:
application/json:
schema:
type: array
- items: *556
+ items: *553
examples:
- default: *635
+ default: *632
headers:
Link: *45
'404': *6
@@ -104971,9 +104542,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *444
- - *445
- - *694
+ - *441
+ - *442
+ - *691
requestBody:
required: true
content:
@@ -105003,16 +104574,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'201':
description: Reaction created
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'422': *15
x-github:
githubCloudOnly: false
@@ -105034,10 +104605,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *444
- - *445
- - *694
- - *636
+ - *441
+ - *442
+ - *691
+ - *633
responses:
'204':
description: Response
@@ -105061,9 +104632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *444
- - *445
- - *497
+ - *441
+ - *442
+ - *494
- *17
- *19
responses:
@@ -105080,7 +104651,7 @@ paths:
oneOf:
- allOf:
- *163
- - &695
+ - &692
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -105101,67 +104672,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *164
- - *695
+ - *692
- allOf:
- *165
- - *695
+ - *692
- allOf:
- *166
- - *695
+ - *692
- allOf:
- - *696
- - *695
+ - *693
+ - *692
- allOf:
- *167
- - *695
+ - *692
- allOf:
- *168
- - *695
+ - *692
- allOf:
- *169
- - *695
+ - *692
- allOf:
- *170
- - *695
+ - *692
- allOf:
- *171
- - *695
+ - *692
- allOf:
- *172
- - *695
+ - *692
- allOf:
- *173
- - *695
+ - *692
- allOf:
- *174
- - *695
+ - *692
- allOf:
- *175
- - *695
+ - *692
- allOf:
- *176
- - *695
+ - *692
- allOf:
- *177
- - *695
+ - *692
- allOf:
- *178
- - *695
+ - *692
- allOf:
- *179
- - *695
+ - *692
- allOf:
- *180
- - *695
+ - *692
- allOf:
- *181
- - *695
+ - *692
- allOf:
- *182
- - *695
+ - *692
- allOf:
- *183
- - *695
+ - *692
examples:
default:
value:
@@ -105200,8 +104771,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- name: includes_parents
@@ -105212,7 +104783,7 @@ paths:
schema:
type: boolean
default: true
- - *697
+ - *694
responses:
'200':
description: Response
@@ -105267,8 +104838,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
description: Request body
required: true
@@ -105297,7 +104868,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *698
+ items: *695
required:
- name
- enforcement
@@ -105330,7 +104901,7 @@ paths:
application/json:
schema: *184
examples:
- default: &707
+ default: &704
value:
id: 42
name: super cool ruleset
@@ -105377,12 +104948,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *444
- - *445
- - *699
+ - *441
+ - *442
+ - *696
- *103
- - *700
- - *701
+ - *697
+ - *698
- *17
- *19
responses:
@@ -105390,9 +104961,9 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: *703
+ default: *700
'404': *6
'500': *38
x-github:
@@ -105413,17 +104984,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *444
- - *445
- - *704
+ - *441
+ - *442
+ - *701
responses:
'200':
description: Response
content:
application/json:
- schema: *705
+ schema: *702
examples:
- default: *706
+ default: *703
'404': *6
'500': *38
x-github:
@@ -105451,8 +105022,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105474,7 +105045,7 @@ paths:
application/json:
schema: *184
examples:
- default: *707
+ default: *704
'404': *6
'500': *38
put:
@@ -105492,8 +105063,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105527,7 +105098,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *698
+ items: *695
examples:
default:
value:
@@ -105557,7 +105128,7 @@ paths:
application/json:
schema: *184
examples:
- default: *707
+ default: *704
'404': *6
'500': *38
delete:
@@ -105575,8 +105146,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105599,8 +105170,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
- name: ruleset_id
@@ -105637,8 +105208,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -105711,8 +105282,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:
- - *444
- - *445
+ - *441
+ - *442
- *410
- *411
- *412
@@ -105721,8 +105292,8 @@ paths:
- *108
- *19
- *17
- - *708
- - *709
+ - *705
+ - *706
- *415
- *416
- *417
@@ -105734,7 +105305,7 @@ paths:
application/json:
schema:
type: array
- items: &713
+ items: &710
type: object
properties:
number: *123
@@ -105750,8 +105321,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *710
- resolution: *711
+ state: *707
+ resolution: *708
resolved_at:
type:
- string
@@ -105845,7 +105416,7 @@ paths:
first_location_detected:
anyOf:
- type: 'null'
- - *712
+ - *709
has_more_locations:
type: boolean
description: A boolean value representing whether or not the
@@ -105990,16 +105561,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *418
responses:
'200':
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
default:
value:
@@ -106053,9 +105624,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
requestBody:
required: true
content:
@@ -106063,8 +105634,8 @@ paths:
schema:
type: object
properties:
- state: *710
- resolution: *711
+ state: *707
+ resolution: *708
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -106100,7 +105671,7 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
default:
value:
@@ -106195,9 +105766,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:
- - *444
- - *445
- - *524
+ - *441
+ - *442
+ - *521
- *19
- *17
responses:
@@ -106208,7 +105779,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &896
+ items: &891
type: object
properties:
type:
@@ -106235,6 +105806,9 @@ paths:
- commit
details:
oneOf:
+ - *711
+ - *712
+ - *713
- *714
- *715
- *716
@@ -106245,9 +105819,6 @@ paths:
- *721
- *722
- *723
- - *724
- - *725
- - *726
examples:
default:
value:
@@ -106333,8 +105904,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -106342,14 +105913,14 @@ paths:
schema:
type: object
properties:
- reason: &728
+ reason: &725
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *727
+ placeholder_id: *724
required:
- reason
- placeholder_id
@@ -106366,7 +105937,7 @@ paths:
schema:
type: object
properties:
- reason: *728
+ reason: *725
expire_at:
type:
- string
@@ -106413,8 +105984,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -106429,7 +106000,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &729
+ items: &726
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -106457,15 +106028,15 @@ paths:
the scan is pending
pattern_update_scans:
type: array
- items: *729
+ items: *726
backfill_scans:
type: array
- items: *729
+ items: *726
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *729
+ - *726
- type: object
properties:
pattern_name:
@@ -106535,8 +106106,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *108
- name: sort
description: The property to sort the results by.
@@ -106580,9 +106151,9 @@ paths:
application/json:
schema:
type: array
- items: *730
+ items: *727
examples:
- default: *731
+ default: *728
'400': *14
'404': *6
x-github:
@@ -106605,8 +106176,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -106776,9 +106347,9 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: &733
+ default: &730
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -107011,8 +106582,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -107125,7 +106696,7 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
default:
value:
@@ -107272,17 +106843,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'200':
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: *733
+ default: *730
'403': *27
'404': *6
x-github:
@@ -107306,9 +106877,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
requestBody:
required: true
content:
@@ -107479,10 +107050,10 @@ paths:
description: Response
content:
application/json:
- schema: *730
+ schema: *727
examples:
- default: *733
- add_credit: *733
+ default: *730
+ add_credit: *730
'403': *27
'404': *6
'422':
@@ -107520,9 +107091,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'202': *37
'400': *14
@@ -107549,17 +107120,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:
- - *444
- - *445
- - *732
+ - *441
+ - *442
+ - *729
responses:
'202':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
'400': *14
'422': *15
'403': *27
@@ -107585,8 +107156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -107682,8 +107253,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -107692,7 +107263,7 @@ paths:
application/json:
schema:
type: array
- items: &734
+ items: &731
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -107725,8 +107296,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -107804,8 +107375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -107899,8 +107470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -108054,8 +107625,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -108065,7 +107636,7 @@ paths:
application/json:
schema:
type: array
- items: *734
+ items: *731
examples:
default:
value:
@@ -108098,8 +107669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: sha
in: path
required: true
@@ -108155,7 +107726,7 @@ paths:
description: Response
content:
application/json:
- schema: *735
+ schema: *732
examples:
default:
value:
@@ -108209,8 +107780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108242,14 +107813,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &736
+ schema: &733
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -108322,8 +107893,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -108349,7 +107920,7 @@ paths:
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -108376,8 +107947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -108397,8 +107968,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108480,8 +108051,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -108489,7 +108060,7 @@ paths:
application/json:
schema:
type: array
- items: &737
+ items: &734
title: Tag protection
description: Tag protection
type: object
@@ -108546,8 +108117,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:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -108570,7 +108141,7 @@ paths:
description: Response
content:
application/json:
- schema: *737
+ schema: *734
examples:
default:
value:
@@ -108601,8 +108172,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:
- - *444
- - *445
+ - *441
+ - *442
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -108639,8 +108210,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
in: path
required: true
@@ -108676,8 +108247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *17
- *19
responses:
@@ -108709,8 +108280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *444
- - *445
+ - *441
+ - *442
- *19
- *17
responses:
@@ -108718,7 +108289,7 @@ paths:
description: Response
content:
application/json:
- schema: &738
+ schema: &735
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -108730,7 +108301,7 @@ paths:
required:
- names
examples:
- default: &739
+ default: &736
value:
names:
- octocat
@@ -108753,8 +108324,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -108785,9 +108356,9 @@ paths:
description: Response
content:
application/json:
- schema: *738
+ schema: *735
examples:
- default: *739
+ default: *736
'404': *6
'422': *7
x-github:
@@ -108808,9 +108379,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *444
- - *445
- - &740
+ - *441
+ - *442
+ - &737
name: per
description: The time frame to display results for.
in: query
@@ -108841,7 +108412,7 @@ paths:
- 128
clones:
type: array
- items: &741
+ items: &738
title: Traffic
type: object
properties:
@@ -108929,8 +108500,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -109025,8 +108596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'200':
description: Response
@@ -109090,9 +108661,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *444
- - *445
- - *740
+ - *441
+ - *442
+ - *737
responses:
'200':
description: Response
@@ -109113,7 +108684,7 @@ paths:
- 3782
views:
type: array
- items: *741
+ items: *738
required:
- uniques
- count
@@ -109191,8 +108762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *444
- - *445
+ - *441
+ - *442
requestBody:
required: true
content:
@@ -109466,8 +109037,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -109490,8 +109061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -109513,8 +109084,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -109540,8 +109111,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *444
- - *445
+ - *441
+ - *442
- name: ref
in: path
required: true
@@ -109633,9 +109204,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -109786,7 +109357,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &749
+ - &746
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -109796,7 +109367,7 @@ paths:
type: string
examples:
- members
- - &754
+ - &751
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -109808,7 +109379,7 @@ paths:
format: int32
examples:
- 1
- - &755
+ - &752
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -109852,7 +109423,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &744
+ items: &741
allOf:
- type: object
required:
@@ -109934,7 +109505,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: &756
+ meta: &753
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -109999,30 +109570,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &745
+ '400': &742
description: Bad request
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '401': *743
- '403': &746
+ schema: *739
+ '401': *740
+ '403': &743
description: Permission denied
- '429': &747
+ '429': &744
description: Too many requests
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '500': &748
+ schema: *739
+ '500': &745
description: Internal server error
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
+ schema: *739
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110046,7 +109617,7 @@ paths:
required: true
content:
application/json:
- schema: &752
+ schema: &749
type: object
required:
- schemas
@@ -110110,9 +109681,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- group: &750
+ group: &747
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -110131,13 +109702,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': *745
- '401': *743
- '403': *746
- '409': &753
+ '400': *742
+ '401': *740
+ '403': *743
+ '409': &750
description: Duplicate record detected
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110154,7 +109725,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:
- - &751
+ - &748
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -110163,22 +109734,22 @@ paths:
type: string
examples:
- 7fce0092-d52e-4f76-b727-3955bd72c939
- - *749
+ - *746
- *39
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- default: *750
- '400': *745
- '401': *743
- '403': *746
+ default: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110197,13 +109768,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:
- - *751
+ - *748
- *39
requestBody:
required: true
content:
application/json:
- schema: *752
+ schema: *749
examples:
group:
summary: Group
@@ -110229,17 +109800,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- group: *750
- groupWithMembers: *750
- '400': *745
- '401': *743
- '403': *746
+ group: *747
+ groupWithMembers: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110263,13 +109834,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:
- - *751
+ - *748
- *39
requestBody:
required: true
content:
application/json:
- schema: &763
+ schema: &760
type: object
required:
- Operations
@@ -110329,17 +109900,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *744
+ schema: *741
examples:
- updateGroup: *750
- addMembers: *750
- '400': *745
- '401': *743
- '403': *746
+ updateGroup: *747
+ addMembers: *747
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110355,17 +109926,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:
- - *751
+ - *748
- *39
responses:
'204':
description: Group was deleted, no content
- '400': *745
- '401': *743
- '403': *746
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110399,8 +109970,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *754
- - *755
+ - *751
+ - *752
- *39
responses:
'200':
@@ -110434,7 +110005,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &758
+ items: &755
allOf:
- type: object
required:
@@ -110526,7 +110097,7 @@ paths:
address.
examples:
- true
- roles: &757
+ roles: &754
type: array
description: The roles assigned to the user.
items:
@@ -110585,7 +110156,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *756
+ meta: *753
startIndex:
type: integer
description: A starting index for the returned page
@@ -110624,11 +110195,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *745
- '401': *743
- '403': *746
- '429': *747
- '500': *748
+ '400': *742
+ '401': *740
+ '403': *743
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110652,7 +110223,7 @@ paths:
required: true
content:
application/json:
- schema: &761
+ schema: &758
type: object
required:
- schemas
@@ -110745,9 +110316,9 @@ paths:
description: Whether this email address is the primary address.
examples:
- true
- roles: *757
+ roles: *754
examples:
- user: &762
+ user: &759
summary: User
value:
schemas:
@@ -110794,9 +110365,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- user: &759
+ user: &756
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -110822,13 +110393,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: *759
- '400': *745
- '401': *743
- '403': *746
- '409': *753
- '429': *747
- '500': *748
+ enterpriseOwner: *756
+ '400': *742
+ '401': *740
+ '403': *743
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110845,7 +110416,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:
- - &760
+ - &757
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -110858,15 +110429,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- default: *759
- '400': *745
- '401': *743
- '403': *746
+ default: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110888,30 +110459,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:
- - *760
+ - *757
- *39
requestBody:
required: true
content:
application/json:
- schema: *761
+ schema: *758
examples:
- user: *762
+ user: *759
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- user: *759
- '400': *745
- '401': *743
- '403': *746
+ user: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -110946,13 +110517,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:
- - *760
+ - *757
- *39
requestBody:
required: true
content:
application/json:
- schema: *763
+ schema: *760
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -110992,18 +110563,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *758
+ schema: *755
examples:
- userMultiValuedProperties: *759
- userSingleValuedProperties: *759
- disableUser: *759
- '400': *745
- '401': *743
- '403': *746
+ userMultiValuedProperties: *756
+ userSingleValuedProperties: *756
+ disableUser: *756
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '409': *753
- '429': *747
- '500': *748
+ '409': *750
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -111023,17 +110594,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:
- - *760
+ - *757
- *39
responses:
'204':
description: User was deleted, no content
- '400': *745
- '401': *743
- '403': *746
+ '400': *742
+ '401': *740
+ '403': *743
'404': *6
- '429': *747
- '500': *748
+ '429': *744
+ '500': *745
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -111124,7 +110695,7 @@ paths:
- 1
Resources:
type: array
- items: &764
+ items: &761
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -111371,22 +110942,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *35
- '404': &765
+ '404': &762
description: Resource not found
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '403': &766
+ schema: *739
+ '403': &763
description: Forbidden
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '400': *745
- '429': *747
+ schema: *739
+ '400': *742
+ '429': *744
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -111412,9 +110983,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: &767
+ default: &764
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -111437,17 +111008,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *35
- '404': *765
- '403': *766
- '500': *748
+ '404': *762
+ '403': *763
+ '500': *745
'409':
description: Conflict
content:
application/json:
- schema: *742
+ schema: *739
application/scim+json:
- schema: *742
- '400': *745
+ schema: *739
+ '400': *742
requestBody:
required: true
content:
@@ -111547,17 +111118,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
- '404': *765
- '403': *766
+ default: *764
+ '404': *762
+ '403': *763
'304': *35
x-github:
githubCloudOnly: true
@@ -111581,18 +111152,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
+ default: *764
'304': *35
- '404': *765
- '403': *766
+ '404': *762
+ '403': *763
requestBody:
required: true
content:
@@ -111707,19 +111278,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *85
- - *760
+ - *757
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *764
+ schema: *761
examples:
- default: *767
+ default: *764
'304': *35
- '404': *765
- '403': *766
- '400': *745
+ '404': *762
+ '403': *763
+ '400': *742
'429':
description: Response
content:
@@ -111815,12 +111386,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *85
- - *760
+ - *757
responses:
'204':
description: Response
- '404': *765
- '403': *766
+ '404': *762
+ '403': *763
'304': *35
x-github:
githubCloudOnly: true
@@ -111954,7 +111525,7 @@ paths:
examples:
- 73..77
- 77..78
- text_matches: &768
+ text_matches: &765
title: Search Result Text Matches
type: array
items:
@@ -112118,7 +111689,7 @@ paths:
enum:
- author-date
- committer-date
- - &769
+ - &766
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
@@ -112187,7 +111758,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
comment_count:
type: integer
message:
@@ -112206,7 +111777,7 @@ paths:
url:
type: string
format: uri
- verification: *618
+ verification: *615
required:
- author
- committer
@@ -112221,7 +111792,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *495
+ - *492
parents:
type: array
items:
@@ -112238,7 +111809,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *768
+ text_matches: *765
required:
- sha
- node_id
@@ -112431,7 +112002,7 @@ paths:
- interactions
- created
- updated
- - *769
+ - *766
- *17
- *19
- name: advanced_search
@@ -112528,11 +112099,11 @@ paths:
type:
- string
- 'null'
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
type: string
state_reason:
@@ -112560,7 +112131,7 @@ paths:
- string
- 'null'
format: date-time
- text_matches: *768
+ text_matches: *765
pull_request:
type: object
properties:
@@ -112783,7 +112354,7 @@ paths:
enum:
- created
- updated
- - *769
+ - *766
- *17
- *19
responses:
@@ -112828,7 +112399,7 @@ paths:
- 'null'
score:
type: number
- text_matches: *768
+ text_matches: *765
required:
- id
- node_id
@@ -112914,7 +112485,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *769
+ - *766
- *17
- *19
responses:
@@ -113151,7 +112722,7 @@ paths:
- admin
- pull
- push
- text_matches: *768
+ text_matches: *765
temp_clone_token:
type: string
allow_merge_commit:
@@ -113460,7 +113031,7 @@ paths:
- string
- 'null'
format: uri
- text_matches: *768
+ text_matches: *765
related:
type:
- array
@@ -113655,7 +113226,7 @@ paths:
- followers
- repositories
- joined
- - *769
+ - *766
- *17
- *19
responses:
@@ -113765,7 +113336,7 @@ paths:
type:
- boolean
- 'null'
- text_matches: *768
+ text_matches: *765
blog:
type:
- string
@@ -113847,7 +113418,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &773
+ - &770
name: team_id
description: The unique identifier of the team.
in: path
@@ -113888,7 +113459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -113989,7 +113560,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *773
+ - *770
responses:
'204':
description: Response
@@ -114020,7 +113591,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
parameters:
- - *773
+ - *770
- *108
- *17
- *19
@@ -114033,7 +113604,7 @@ paths:
type: array
items: *433
examples:
- default: *774
+ default: *771
headers:
Link: *45
x-github:
@@ -114062,7 +113633,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -114125,7 +113696,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
responses:
'200':
@@ -114159,7 +113730,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
requestBody:
required: false
@@ -114185,7 +113756,7 @@ paths:
application/json:
schema: *433
examples:
- default: *775
+ default: *772
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -114210,7 +113781,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *773
+ - *770
- *435
responses:
'204':
@@ -114223,218 +113794,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:
- - *773
- - *435
- - *108
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *436
- examples:
- default: *776
- headers:
- Link: *45
- 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:
- - *773
- - *435
- 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: *436
- examples:
- default: *437
- 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:
- - *773
- - *435
- - *438
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *436
- examples:
- default: *437
- 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:
- - *773
- - *435
- - *438
- 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: *436
- examples:
- default: *777
- 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:
- - *773
- - *435
- - *438
- 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)
@@ -114450,7 +113809,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -114488,7 +113847,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *773
+ - *770
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -114539,7 +113898,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114576,7 +113935,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114616,7 +113975,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114653,16 +114012,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:
- - *773
+ - *770
- *136
responses:
'200':
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-user-is-a-team-maintainer: *778
+ response-if-user-is-a-team-maintainer: *773
'404': *6
x-github:
githubCloudOnly: false
@@ -114695,7 +114054,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:
- - *773
+ - *770
- *136
requestBody:
required: false
@@ -114721,9 +114080,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- response-if-users-membership-with-team-is-now-pending: *779
+ response-if-users-membership-with-team-is-now-pending: *774
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -114757,7 +114116,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:
- - *773
+ - *770
- *136
responses:
'204':
@@ -114785,7 +114144,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -114827,15 +114186,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *780
+ schema: *775
examples:
alternative-response-with-extra-repository-information:
value:
@@ -114986,9 +114345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
requestBody:
required: false
content:
@@ -115038,9 +114397,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *773
- - *444
- - *445
+ - *770
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -115069,15 +114428,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *773
+ - *770
responses:
'200':
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
- default: *447
+ default: *444
'403': *27
'404': *6
x-github:
@@ -115104,7 +114463,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *773
+ - *770
requestBody:
required: true
content:
@@ -115165,7 +114524,7 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -115196,7 +114555,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *773
+ - *770
- *17
- *19
responses:
@@ -115208,7 +114567,7 @@ paths:
type: array
items: *301
examples:
- response-if-child-teams-exist: *781
+ response-if-child-teams-exist: *776
headers:
Link: *45
'404': *6
@@ -115241,7 +114600,7 @@ paths:
application/json:
schema:
oneOf:
- - &783
+ - &778
title: Private User
description: Private User
type: object
@@ -115491,7 +114850,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *782
+ - *777
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -115651,7 +115010,7 @@ paths:
description: Response
content:
application/json:
- schema: *783
+ schema: *778
examples:
default:
value:
@@ -115997,7 +115356,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -116005,7 +115364,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -116049,7 +115408,7 @@ paths:
type: integer
secrets:
type: array
- items: &784
+ items: &779
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -116091,7 +115450,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *549
+ default: *546
headers:
Link: *45
x-github:
@@ -116169,7 +115528,7 @@ paths:
description: Response
content:
application/json:
- schema: *784
+ schema: *779
examples:
default:
value:
@@ -116315,7 +115674,7 @@ paths:
type: array
items: *272
examples:
- default: *785
+ default: *780
'401': *23
'403': *27
'404': *6
@@ -116467,7 +115826,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'304': *35
'500': *38
'401': *23
@@ -116525,7 +115884,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'401': *23
'403': *27
'404': *6
@@ -116582,7 +115941,7 @@ paths:
description: Response
content:
application/json:
- schema: &786
+ schema: &781
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -116635,7 +115994,7 @@ paths:
examples:
- https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &787
+ default: &782
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -116680,9 +116039,9 @@ paths:
description: Response
content:
application/json:
- schema: *786
+ schema: *781
examples:
- default: *787
+ default: *782
'404': *6
x-github:
githubCloudOnly: false
@@ -116719,9 +116078,9 @@ paths:
type: integer
machines:
type: array
- items: *548
+ items: *545
examples:
- default: *788
+ default: *783
'304': *35
'500': *38
'401': *23
@@ -116806,11 +116165,11 @@ paths:
- 26a7c758-7299-4a73-b978-5a92a7ae98a0
owner: *4
billable_owner: *4
- repository: *449
+ repository: *446
machine:
anyOf:
- type: 'null'
- - *548
+ - *545
devcontainer_path:
description: Path to devcontainer.json from repo root used to
create Codespace.
@@ -117615,7 +116974,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'304': *35
'500': *38
'400': *14
@@ -117655,7 +117014,7 @@ paths:
application/json:
schema: *363
examples:
- default: *547
+ default: *544
'500': *38
'401': *23
'403': *27
@@ -117687,7 +117046,7 @@ paths:
type: array
items: *373
examples:
- default: &799
+ default: &794
value:
- id: 197
name: hello_docker
@@ -117788,7 +117147,7 @@ paths:
application/json:
schema:
type: array
- items: &789
+ items: &784
title: Email
description: Email
type: object
@@ -117858,9 +117217,9 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
- default: &801
+ default: &796
value:
- email: octocat@github.com
verified: true
@@ -117937,7 +117296,7 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
default:
value:
@@ -118195,7 +117554,7 @@ paths:
application/json:
schema:
type: array
- items: &790
+ items: &785
title: GPG Key
description: A unique encryption key
type: object
@@ -118340,7 +117699,7 @@ paths:
- subkeys
- revoked
examples:
- default: &815
+ default: &810
value:
- id: 3
name: Octocat's GPG Key
@@ -118425,9 +117784,9 @@ paths:
description: Response
content:
application/json:
- schema: *790
+ schema: *785
examples:
- default: &791
+ default: &786
value:
id: 3
name: Octocat's GPG Key
@@ -118484,7 +117843,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &792
+ - &787
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -118496,9 +117855,9 @@ paths:
description: Response
content:
application/json:
- schema: *790
+ schema: *785
examples:
- default: *791
+ default: *786
'404': *6
'304': *35
'403': *27
@@ -118521,7 +117880,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *792
+ - *787
responses:
'204':
description: Response
@@ -118826,7 +118185,7 @@ paths:
required: true
content:
application/json:
- schema: *629
+ schema: *626
examples:
default:
value:
@@ -118976,7 +118335,7 @@ paths:
application/json:
schema:
type: array
- items: &793
+ items: &788
title: Key
description: Key
type: object
@@ -119079,9 +118438,9 @@ paths:
description: Response
content:
application/json:
- schema: *793
+ schema: *788
examples:
- default: &794
+ default: &789
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -119114,15 +118473,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *658
+ - *655
responses:
'200':
description: Response
content:
application/json:
- schema: *793
+ schema: *788
examples:
- default: *794
+ default: *789
'404': *6
'304': *35
'403': *27
@@ -119145,7 +118504,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *658
+ - *655
responses:
'204':
description: Response
@@ -119178,7 +118537,7 @@ paths:
application/json:
schema:
type: array
- items: &795
+ items: &790
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -119257,7 +118616,7 @@ paths:
- account
- plan
examples:
- default: &796
+ default: &791
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -119319,9 +118678,9 @@ paths:
application/json:
schema:
type: array
- items: *795
+ items: *790
examples:
- default: *796
+ default: *791
headers:
Link: *45
'304': *35
@@ -120339,7 +119698,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *369
- - *797
+ - *792
responses:
'204':
description: Response
@@ -120454,7 +119813,7 @@ paths:
- docker
- nuget
- container
- - *798
+ - *793
- *19
- *17
responses:
@@ -120466,8 +119825,8 @@ paths:
type: array
items: *373
examples:
- default: *799
- '400': *800
+ default: *794
+ '400': *795
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120496,7 +119855,7 @@ paths:
application/json:
schema: *373
examples:
- default: &816
+ default: &811
value:
id: 40201
name: octo-name
@@ -120858,9 +120217,9 @@ paths:
application/json:
schema:
type: array
- items: *789
+ items: *784
examples:
- default: *801
+ default: *796
headers:
Link: *45
'304': *35
@@ -120973,7 +120332,7 @@ paths:
type: array
items: *76
examples:
- default: &808
+ default: &803
summary: Default response
value:
- id: 1296269
@@ -121291,9 +120650,9 @@ paths:
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
- default: *451
+ default: *448
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -121331,9 +120690,9 @@ paths:
application/json:
schema:
type: array
- items: *631
+ items: *628
examples:
- default: *802
+ default: *797
headers:
Link: *45
'304': *35
@@ -121412,7 +120771,7 @@ paths:
application/json:
schema:
type: array
- items: &803
+ items: &798
title: Social account
description: Social media account
type: object
@@ -121429,7 +120788,7 @@ paths:
- provider
- url
examples:
- default: &804
+ default: &799
value:
- provider: twitter
url: https://twitter.com/github
@@ -121492,9 +120851,9 @@ paths:
application/json:
schema:
type: array
- items: *803
+ items: *798
examples:
- default: *804
+ default: *799
'422': *15
'304': *35
'404': *6
@@ -121582,7 +120941,7 @@ paths:
application/json:
schema:
type: array
- items: &805
+ items: &800
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -121602,7 +120961,7 @@ paths:
- title
- created_at
examples:
- default: &830
+ default: &825
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -121667,9 +121026,9 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
- default: &806
+ default: &801
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -121699,7 +121058,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:
- - &807
+ - &802
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -121711,9 +121070,9 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
- default: *806
+ default: *801
'404': *6
'304': *35
'403': *27
@@ -121736,7 +121095,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:
- - *807
+ - *802
responses:
'204':
description: Response
@@ -121765,7 +121124,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:
- - &831
+ - &826
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
@@ -121790,11 +121149,11 @@ paths:
type: array
items: *76
examples:
- default-response: *808
+ default-response: *803
application/vnd.github.v3.star+json:
schema:
type: array
- items: &832
+ items: &827
title: Starred Repository
description: Starred Repository
type: object
@@ -121950,8 +121309,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response if this repository is starred by you
@@ -121979,8 +121338,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -122004,8 +121363,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:
- - *444
- - *445
+ - *441
+ - *442
responses:
'204':
description: Response
@@ -122163,10 +121522,10 @@ paths:
application/json:
schema:
oneOf:
- - *783
- - *782
+ - *778
+ - *777
examples:
- default-response: &810
+ default-response: &805
summary: Default response
value:
login: octocat
@@ -122201,7 +121560,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &811
+ response-with-git-hub-plan-information: &806
summary: Response with GitHub plan information
value:
login: octocat
@@ -122323,7 +121682,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *809
+ - *804
- *17
responses:
'200':
@@ -122372,11 +121731,11 @@ paths:
application/json:
schema:
oneOf:
- - *783
- - *782
+ - *778
+ - *777
examples:
- default-response: *810
- response-with-git-hub-plan-information: *811
+ default-response: *805
+ response-with-git-hub-plan-information: *806
'404': *6
x-github:
githubCloudOnly: false
@@ -122426,8 +121785,8 @@ paths:
required:
- subject_digests
examples:
- default: *812
- withPredicateType: *813
+ default: *807
+ withPredicateType: *808
responses:
'200':
description: Response
@@ -122481,7 +121840,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *814
+ default: *809
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -122686,7 +122045,7 @@ paths:
initiator:
type: string
examples:
- default: *491
+ default: *488
'201':
description: Response
content:
@@ -122727,7 +122086,7 @@ paths:
type: array
items: *373
examples:
- default: *799
+ default: *794
'403': *27
'401': *23
x-github:
@@ -123111,9 +122470,9 @@ paths:
application/json:
schema:
type: array
- items: *790
+ items: *785
examples:
- default: *815
+ default: *810
headers:
Link: *45
x-github:
@@ -123217,7 +122576,7 @@ paths:
application/json:
schema: *20
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123342,7 +122701,7 @@ paths:
- docker
- nuget
- container
- - *798
+ - *793
- *136
- *19
- *17
@@ -123355,10 +122714,10 @@ paths:
type: array
items: *373
examples:
- default: *799
+ default: *794
'403': *27
'401': *23
- '400': *800
+ '400': *795
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123388,7 +122747,7 @@ paths:
application/json:
schema: *373
examples:
- default: *816
+ default: *811
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -123737,7 +123096,7 @@ paths:
type: array
items: *394
examples:
- default: *817
+ default: *812
headers:
Link: *45
'304': *35
@@ -123797,7 +123156,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *818
+ items: *813
required:
- name
- data_type
@@ -123813,7 +123172,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *819
+ iteration_configuration: *814
required:
- name
- data_type
@@ -123835,8 +123194,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *820
- iteration_field: *821
+ single_select_field: *815
+ iteration_field: *816
responses:
'201':
description: Response
@@ -123844,11 +123203,11 @@ paths:
application/json:
schema: *394
examples:
- text_field: *822
- number_field: *823
- date_field: *824
- single_select_field: *825
- iteration_field: *826
+ text_field: *817
+ number_field: *818
+ date_field: *819
+ single_select_field: *820
+ iteration_field: *821
'304': *35
'403': *27
'401': *23
@@ -123870,7 +123229,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *391
- - *827
+ - *822
- *136
responses:
'200':
@@ -123879,7 +123238,7 @@ paths:
application/json:
schema: *394
examples:
- default: *828
+ default: *823
headers:
Link: *45
'304': *35
@@ -124232,7 +123591,7 @@ paths:
parameters:
- *391
- *136
- - *829
+ - *824
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -124511,9 +123870,9 @@ paths:
application/json:
schema:
type: array
- items: *803
+ items: *798
examples:
- default: *804
+ default: *799
headers:
Link: *45
x-github:
@@ -124543,9 +123902,9 @@ paths:
application/json:
schema:
type: array
- items: *805
+ items: *800
examples:
- default: *830
+ default: *825
headers:
Link: *45
x-github:
@@ -124570,7 +123929,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *136
- - *831
+ - *826
- *108
- *17
- *19
@@ -124582,11 +123941,11 @@ paths:
schema:
anyOf:
- type: array
- items: *832
+ items: *827
- type: array
items: *76
examples:
- default-response: *808
+ default-response: *803
headers:
Link: *45
x-github:
@@ -124746,7 +124105,7 @@ webhooks:
type: string
enum:
- disabled
- enterprise: &833
+ enterprise: &828
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -124815,7 +124174,7 @@ webhooks:
- created_at
- updated_at
- avatar_url
- installation: &834
+ installation: &829
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -124836,7 +124195,7 @@ webhooks:
required:
- id
- node_id
- organization: &835
+ organization: &830
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -124909,7 +124268,7 @@ webhooks:
- public_members_url
- avatar_url
- description
- repository: &836
+ repository: &831
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
@@ -125822,10 +125181,10 @@ webhooks:
type: string
enum:
- enabled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -125901,11 +125260,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: &837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: &832
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)
@@ -126128,11 +125487,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: *832
sender: *4
required:
- action
@@ -126320,11 +125679,11 @@ webhooks:
- everyone
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- rule: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ rule: *832
sender: *4
required:
- action
@@ -126397,7 +125756,7 @@ webhooks:
required: true
content:
application/json:
- schema: &857
+ schema: &852
title: Exemption request cancellation event
type: object
properties:
@@ -126405,11 +125764,11 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: &838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: &833
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -126683,7 +126042,7 @@ webhooks:
- array
- 'null'
description: The responses to the exemption request.
- items: &839
+ items: &834
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -126795,7 +126154,7 @@ webhooks:
required: true
content:
application/json:
- schema: &858
+ schema: &853
title: Exemption request completed event
type: object
properties:
@@ -126803,11 +126162,11 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
sender: *4
required:
- action
@@ -126879,7 +126238,7 @@ webhooks:
required: true
content:
application/json:
- schema: &855
+ schema: &850
title: Exemption request created event
type: object
properties:
@@ -126887,11 +126246,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
sender: *4
required:
- action
@@ -126963,7 +126322,7 @@ webhooks:
required: true
content:
application/json:
- schema: &859
+ schema: &854
title: Exemption response dismissed event
type: object
properties:
@@ -126971,12 +126330,12 @@ webhooks:
type: string
enum:
- response_dismissed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
- exemption_response: *839
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
+ exemption_response: *834
sender: *4
required:
- action
@@ -127050,7 +126409,7 @@ webhooks:
required: true
content:
application/json:
- schema: &856
+ schema: &851
title: Exemption response submitted event
type: object
properties:
@@ -127058,12 +126417,12 @@ webhooks:
type: string
enum:
- response_submitted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- exemption_request: *838
- exemption_response: *839
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ exemption_request: *833
+ exemption_response: *834
sender: *4
required:
- action
@@ -127147,7 +126506,7 @@ webhooks:
type: string
enum:
- completed
- check_run: &841
+ check_run: &836
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -127257,7 +126616,7 @@ webhooks:
-
examples:
- neutral
- deployment: *840
+ deployment: *835
details_url:
type: string
examples:
@@ -127355,10 +126714,10 @@ webhooks:
- output
- app
- pull_requests
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -127751,11 +127110,11 @@ webhooks:
type: string
enum:
- created
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -128151,11 +127510,11 @@ webhooks:
type: string
enum:
- requested_action
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
requested_action:
description: The action requested by the user.
type: object
@@ -128560,11 +127919,11 @@ webhooks:
type: string
enum:
- rerequested
- check_run: *841
- installation: *834
- enterprise: *833
- organization: *835
- repository: *836
+ check_run: *836
+ installation: *829
+ enterprise: *828
+ organization: *830
+ repository: *831
sender: *4
required:
- check_run
@@ -129556,10 +128915,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -130268,10 +129627,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -130974,10 +130333,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -131146,7 +130505,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -131298,20 +130657,20 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &842
+ commit_oid: &837
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: *833
- installation: *834
- organization: *835
- ref: &843
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: &838
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: *836
+ repository: *831
sender: *4
required:
- action
@@ -131478,7 +130837,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -131719,12 +131078,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -131822,7 +131181,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132007,12 +131366,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -132181,7 +131540,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -132358,12 +131717,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -132464,7 +131823,7 @@ webhooks:
type:
- object
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132653,9 +132012,9 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
@@ -132663,7 +132022,7 @@ webhooks:
type:
- string
- 'null'
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -132762,7 +132121,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -132909,12 +132268,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *842
- enterprise: *833
- installation: *834
- organization: *835
- ref: *843
- repository: *836
+ commit_oid: *837
+ enterprise: *828
+ installation: *829
+ organization: *830
+ ref: *838
+ repository: *831
sender: *4
required:
- action
@@ -133083,7 +132442,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *519
+ dismissed_comment: *516
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -133235,10 +132594,10 @@ webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -133498,10 +132857,10 @@ webhooks:
- updated_at
- author_association
- body
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -133582,18 +132941,18 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *835
- pusher_type: &844
+ organization: *830
+ pusher_type: &839
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &845
+ ref: &840
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -133603,7 +132962,7 @@ webhooks:
enum:
- tag
- branch
- repository: *836
+ repository: *831
sender: *4
required:
- ref
@@ -133686,9 +133045,9 @@ webhooks:
enum:
- created
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133773,9 +133132,9 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133853,9 +133212,9 @@ webhooks:
enum:
- promote_to_enterprise
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -133933,9 +133292,9 @@ webhooks:
enum:
- updated
definition: *150
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -134012,10 +133371,10 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- repository: *836
- organization: *835
+ enterprise: *828
+ installation: *829
+ repository: *831
+ organization: *830
sender: *4
new_property_values:
type: array
@@ -134100,18 +133459,18 @@ webhooks:
title: delete event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- pusher_type: *844
- ref: *845
+ enterprise: *828
+ installation: *829
+ organization: *830
+ pusher_type: *839
+ ref: *840
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *836
+ repository: *831
sender: *4
required:
- ref
@@ -134195,11 +133554,11 @@ webhooks:
type: string
enum:
- auto_dismissed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134283,11 +133642,11 @@ webhooks:
type: string
enum:
- auto_reopened
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134371,11 +133730,11 @@ webhooks:
type: string
enum:
- created
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134457,11 +133816,11 @@ webhooks:
type: string
enum:
- dismissed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134543,11 +133902,11 @@ webhooks:
type: string
enum:
- fixed
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134630,11 +133989,11 @@ webhooks:
type: string
enum:
- reintroduced
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134716,11 +134075,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *577
- installation: *834
- organization: *835
- enterprise: *833
- repository: *836
+ alert: *574
+ installation: *829
+ organization: *830
+ enterprise: *828
+ repository: *831
sender: *4
required:
- action
@@ -134797,9 +134156,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- key: &846
+ enterprise: *828
+ installation: *829
+ key: &841
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -134837,8 +134196,8 @@ webhooks:
- verified
- created_at
- read_only
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -134915,11 +134274,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- key: *846
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ key: *841
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -135491,12 +134850,12 @@ webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: &850
+ workflow: &845
title: Workflow
type:
- object
@@ -136234,13 +135593,13 @@ webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *583
+ deployment: *580
pull_requests:
type: array
- items: *678
- repository: *836
- organization: *835
- installation: *834
+ items: *675
+ repository: *831
+ organization: *830
+ installation: *829
sender: *4
responses:
'200':
@@ -136311,7 +135670,7 @@ webhooks:
type: string
enum:
- approved
- approver: &847
+ approver: &842
type: object
properties:
avatar_url:
@@ -136354,11 +135713,11 @@ webhooks:
type: string
comment:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- reviewers: &848
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ reviewers: &843
type: array
items:
type: object
@@ -136439,7 +135798,7 @@ webhooks:
sender: *4
since:
type: string
- workflow_job_run: &849
+ workflow_job_run: &844
type: object
properties:
conclusion:
@@ -137185,18 +136544,18 @@ webhooks:
type: string
enum:
- rejected
- approver: *847
+ approver: *842
comment:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- reviewers: *848
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ reviewers: *843
sender: *4
since:
type: string
- workflow_job_run: *849
+ workflow_job_run: *844
workflow_job_runs:
type: array
items:
@@ -137913,13 +137272,13 @@ webhooks:
type: string
enum:
- requested
- enterprise: *833
+ enterprise: *828
environment:
type: string
- installation: *834
- organization: *835
- repository: *836
- requestor: &860
+ installation: *829
+ organization: *830
+ repository: *831
+ requestor: &855
title: User
type:
- object
@@ -139862,12 +139221,12 @@ webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Deployment Workflow Run
type:
@@ -140558,7 +139917,7 @@ webhooks:
type: string
enum:
- answered
- answer: &853
+ answer: &848
type: object
properties:
author_association:
@@ -140718,11 +140077,11 @@ webhooks:
- created_at
- updated_at
- body
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -140849,11 +140208,11 @@ webhooks:
- from
required:
- category
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -140936,11 +140295,11 @@ webhooks:
type: string
enum:
- closed
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141022,7 +140381,7 @@ webhooks:
type: string
enum:
- created
- comment: &852
+ comment: &847
type: object
properties:
author_association:
@@ -141182,11 +140541,11 @@ webhooks:
- updated_at
- body
- reactions
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141269,12 +140628,12 @@ webhooks:
type: string
enum:
- deleted
- comment: *852
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ comment: *847
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141369,12 +140728,12 @@ webhooks:
- from
required:
- body
- comment: *852
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ comment: *847
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141458,11 +140817,11 @@ webhooks:
type: string
enum:
- created
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141544,11 +140903,11 @@ webhooks:
type: string
enum:
- deleted
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141648,11 +141007,11 @@ webhooks:
type: string
required:
- from
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141734,10 +141093,10 @@ webhooks:
type: string
enum:
- labeled
- discussion: *851
- enterprise: *833
- installation: *834
- label: &854
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ label: &849
title: Label
type: object
properties:
@@ -141770,8 +141129,8 @@ webhooks:
- color
- default
- description
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141854,11 +141213,11 @@ webhooks:
type: string
enum:
- locked
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -141940,11 +141299,11 @@ webhooks:
type: string
enum:
- pinned
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142026,11 +141385,11 @@ webhooks:
type: string
enum:
- reopened
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142115,16 +141474,16 @@ webhooks:
changes:
type: object
properties:
- new_discussion: *851
- new_repository: *836
+ new_discussion: *846
+ new_repository: *831
required:
- new_discussion
- new_repository
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142207,10 +141566,10 @@ webhooks:
type: string
enum:
- unanswered
- discussion: *851
- old_answer: *853
- organization: *835
- repository: *836
+ discussion: *846
+ old_answer: *848
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142292,12 +141651,12 @@ webhooks:
type: string
enum:
- unlabeled
- discussion: *851
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142380,11 +141739,11 @@ webhooks:
type: string
enum:
- unlocked
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142466,11 +141825,11 @@ webhooks:
type: string
enum:
- unpinned
- discussion: *851
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ discussion: *846
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -142539,7 +141898,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142602,7 +141961,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142665,7 +142024,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142728,7 +142087,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142791,7 +142150,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142857,7 +142216,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142923,7 +142282,7 @@ webhooks:
required: true
content:
application/json:
- schema: *858
+ schema: *853
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -142989,7 +142348,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143055,7 +142414,7 @@ webhooks:
required: true
content:
application/json:
- schema: *859
+ schema: *854
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143121,7 +142480,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143186,7 +142545,7 @@ webhooks:
required: true
content:
application/json:
- schema: *857
+ schema: *852
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143251,7 +142610,7 @@ webhooks:
required: true
content:
application/json:
- schema: *858
+ schema: *853
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143316,7 +142675,7 @@ webhooks:
required: true
content:
application/json:
- schema: *855
+ schema: *850
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143381,7 +142740,7 @@ webhooks:
required: true
content:
application/json:
- schema: *859
+ schema: *854
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143447,7 +142806,7 @@ webhooks:
required: true
content:
application/json:
- schema: *856
+ schema: *851
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -143514,7 +142873,7 @@ webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *833
+ enterprise: *828
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -144192,9 +143551,9 @@ webhooks:
type: integer
watchers_count:
type: integer
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- forkee
@@ -144340,9 +143699,9 @@ webhooks:
title: gollum event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pages:
description: The pages that were updated.
type: array
@@ -144380,7 +143739,7 @@ webhooks:
- action
- sha
- html_url
- repository: *836
+ repository: *831
sender: *4
required:
- pages
@@ -144456,10 +143815,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: &861
+ organization: *830
+ repositories: &856
description: An array of repository objects that the installation
can access.
type: array
@@ -144485,8 +143844,8 @@ webhooks:
- name
- full_name
- private
- repository: *836
- requester: *860
+ repository: *831
+ requester: *855
sender: *4
required:
- action
@@ -144561,11 +143920,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -144642,11 +144001,11 @@ webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -144723,10 +144082,10 @@ webhooks:
type: string
enum:
- added
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories_added: &862
+ organization: *830
+ repositories_added: &857
description: An array of repository objects, which were added to
the installation.
type: array
@@ -144772,15 +144131,15 @@ webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *836
- repository_selection: &863
+ repository: *831
+ repository_selection: &858
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *860
+ requester: *855
sender: *4
required:
- action
@@ -144859,10 +144218,10 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories_added: *862
+ organization: *830
+ repositories_added: *857
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -144889,9 +144248,9 @@ webhooks:
- name
- full_name
- private
- repository: *836
- repository_selection: *863
- requester: *860
+ repository: *831
+ repository_selection: *858
+ requester: *855
sender: *4
required:
- action
@@ -144970,11 +144329,11 @@ webhooks:
type: string
enum:
- suspend
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -145157,10 +144516,10 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
target_type:
type: string
@@ -145239,11 +144598,11 @@ webhooks:
type: string
enum:
- unsuspend
- enterprise: *833
+ enterprise: *828
installation: *20
- organization: *835
- repositories: *861
- repository: *836
+ organization: *830
+ repositories: *856
+ repository: *831
requester:
type:
- 'null'
@@ -145491,8 +144850,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -146309,8 +145668,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -146671,8 +146030,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -146752,7 +146111,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &864
+ comment: &859
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -146919,8 +146278,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -147733,8 +147092,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148097,8 +147456,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -148178,7 +147537,7 @@ webhooks:
type: string
enum:
- edited
- changes: &888
+ changes: &883
description: The changes to the comment.
type: object
properties:
@@ -148190,9 +147549,9 @@ webhooks:
type: string
required:
- from
- comment: *864
- enterprise: *833
- installation: *834
+ comment: *859
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -149008,8 +148367,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149370,8 +148729,8 @@ webhooks:
- state
- locked
- assignee
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149461,9 +148820,9 @@ webhooks:
type: number
blocking_issue: *212
blocking_issue_repo: *76
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149552,9 +148911,9 @@ webhooks:
type: number
blocking_issue: *212
blocking_issue_repo: *76
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149642,9 +149001,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149733,9 +149092,9 @@ webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -149815,10 +149174,10 @@ webhooks:
type: string
enum:
- assigned
- assignee: *860
- enterprise: *833
- installation: *834
- issue: &867
+ assignee: *855
+ enterprise: *828
+ installation: *829
+ issue: &862
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -150630,11 +149989,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150754,8 +150113,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -150835,8 +150194,8 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -151653,11 +151012,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151920,8 +151279,8 @@ webhooks:
required:
- state
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -152000,8 +151359,8 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152809,11 +152168,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152932,8 +152291,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -153012,8 +152371,8 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153844,11 +153203,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153946,7 +153305,7 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: &865
+ milestone: &860
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -154089,8 +153448,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -154189,8 +153548,8 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -155002,11 +154361,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -155126,9 +154485,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *854
- organization: *835
- repository: *836
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -155208,8 +154567,8 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -156020,11 +155379,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156144,9 +155503,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *854
- organization: *835
- repository: *836
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -156226,8 +155585,8 @@ webhooks:
type: string
enum:
- locked
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -157063,11 +156422,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157164,8 +156523,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -157244,8 +156603,8 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -158075,11 +157434,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158176,9 +157535,9 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: *865
- organization: *835
- repository: *836
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -159070,11 +158429,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -159651,8 +159010,8 @@ webhooks:
required:
- old_issue
- old_repository
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -160464,11 +159823,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160587,8 +159946,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -160668,9 +160027,9 @@ webhooks:
type: string
enum:
- pinned
- enterprise: *833
- installation: *834
- issue: &866
+ enterprise: *828
+ installation: *829
+ issue: &861
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -161476,11 +160835,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161599,8 +160958,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -161679,8 +161038,8 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -162514,11 +161873,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -162616,8 +161975,8 @@ webhooks:
user_view_type:
type: string
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -163506,11 +162865,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -164109,11 +163468,11 @@ webhooks:
required:
- new_issue
- new_repository
- enterprise: *833
- installation: *834
- issue: *866
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *861
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164193,12 +163552,12 @@ webhooks:
type: string
enum:
- typed
- enterprise: *833
- installation: *834
- issue: *867
+ enterprise: *828
+ installation: *829
+ issue: *862
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164279,7 +163638,7 @@ webhooks:
type: string
enum:
- unassigned
- assignee: &891
+ assignee: &886
title: User
type:
- object
@@ -164351,11 +163710,11 @@ webhooks:
required:
- login
- id
- enterprise: *833
- installation: *834
- issue: *867
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *862
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164434,12 +163793,12 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *833
- installation: *834
- issue: *867
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *862
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -164519,8 +163878,8 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -165354,11 +164713,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *770
- issue_dependencies_summary: *771
+ sub_issues_summary: *767
+ issue_dependencies_summary: *768
issue_field_values:
type: array
- items: *772
+ items: *769
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -165455,8 +164814,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165536,11 +164895,11 @@ webhooks:
type: string
enum:
- unpinned
- enterprise: *833
- installation: *834
- issue: *866
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ issue: *861
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165619,12 +164978,12 @@ webhooks:
type: string
enum:
- untyped
- enterprise: *833
- installation: *834
- issue: *867
+ enterprise: *828
+ installation: *829
+ issue: *862
type: *358
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165704,11 +165063,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165786,11 +165145,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165900,11 +165259,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- label: *854
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ label: *849
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -165986,9 +165345,9 @@ webhooks:
- cancelled
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: &868
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: &863
title: Marketplace Purchase
type: object
required:
@@ -166076,8 +165435,8 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *835
- previous_marketplace_purchase: &869
+ organization: *830
+ previous_marketplace_purchase: &864
title: Marketplace Purchase
type: object
properties:
@@ -166161,7 +165520,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166241,10 +165600,10 @@ webhooks:
- changed
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166332,7 +165691,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166414,10 +165773,10 @@ webhooks:
- pending_change
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166503,7 +165862,7 @@ webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -166584,8 +165943,8 @@ webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -166671,9 +166030,9 @@ webhooks:
type: integer
unit_count:
type: integer
- organization: *835
- previous_marketplace_purchase: *869
- repository: *836
+ organization: *830
+ previous_marketplace_purchase: *864
+ repository: *831
sender: *4
required:
- action
@@ -166753,12 +166112,12 @@ webhooks:
- purchased
effective_date:
type: string
- enterprise: *833
- installation: *834
- marketplace_purchase: *868
- organization: *835
- previous_marketplace_purchase: *869
- repository: *836
+ enterprise: *828
+ installation: *829
+ marketplace_purchase: *863
+ organization: *830
+ previous_marketplace_purchase: *864
+ repository: *831
sender: *4
required:
- action
@@ -166860,11 +166219,11 @@ webhooks:
type: string
required:
- to
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -166966,11 +166325,11 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167049,11 +166408,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167131,11 +166490,11 @@ webhooks:
type: string
enum:
- added
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -167213,7 +166572,7 @@ webhooks:
required:
- login
- id
- team: &870
+ team: &865
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -167443,11 +166802,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *833
- installation: *834
- member: *860
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ member: *855
+ organization: *830
+ repository: *831
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -167526,7 +166885,7 @@ webhooks:
required:
- login
- id
- team: *870
+ team: *865
required:
- action
- scope
@@ -167608,8 +166967,8 @@ webhooks:
type: string
enum:
- checks_requested
- installation: *834
- merge_group: &871
+ installation: *829
+ merge_group: &866
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -167628,15 +166987,15 @@ webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *511
+ head_commit: *508
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167722,10 +167081,10 @@ webhooks:
- merged
- invalidated
- dequeued
- installation: *834
- merge_group: *871
- organization: *835
- repository: *836
+ installation: *829
+ merge_group: *866
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -167798,7 +167157,7 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
+ enterprise: *828
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -167907,12 +167266,12 @@ webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -167992,11 +167351,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168075,9 +167434,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- milestone: &872
+ enterprise: *828
+ installation: *829
+ milestone: &867
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -168219,8 +167578,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168299,11 +167658,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168413,11 +167772,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- milestone: *865
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *860
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168497,11 +167856,11 @@ webhooks:
type: string
enum:
- opened
- enterprise: *833
- installation: *834
- milestone: *872
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ milestone: *867
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168580,11 +167939,11 @@ webhooks:
type: string
enum:
- blocked
- blocked_user: *860
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ blocked_user: *855
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168663,11 +168022,11 @@ webhooks:
type: string
enum:
- unblocked
- blocked_user: *860
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ blocked_user: *855
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -168743,7 +168102,7 @@ webhooks:
enum:
- created
definition: *144
- enterprise: *833
+ enterprise: *828
sender: *4
required:
- action
@@ -168823,8 +168182,8 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
sender: *4
required:
- action
@@ -168897,8 +168256,8 @@ webhooks:
enum:
- updated
definition: *144
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
sender: *4
required:
- action
@@ -168970,9 +168329,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
new_property_values:
type: array
@@ -169060,9 +168419,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- membership: &873
+ enterprise: *828
+ installation: *829
+ membership: &868
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -169172,8 +168531,8 @@ webhooks:
- role
- organization_url
- user
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169251,11 +168610,11 @@ webhooks:
type: string
enum:
- member_added
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169334,8 +168693,8 @@ webhooks:
type: string
enum:
- member_invited
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -169457,10 +168816,10 @@ webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
- user: *860
+ user: *855
required:
- action
- invitation
@@ -169538,11 +168897,11 @@ webhooks:
type: string
enum:
- member_removed
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169629,11 +168988,11 @@ webhooks:
properties:
from:
type: string
- enterprise: *833
- installation: *834
- membership: *873
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ membership: *868
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -169709,9 +169068,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
package:
description: Information about the package.
type: object
@@ -170234,7 +169593,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: &874
+ items: &869
title: Ruby Gems metadata
type: object
properties:
@@ -170331,7 +169690,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -170407,9 +169766,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
package:
description: Information about the package.
type: object
@@ -170771,7 +170130,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *874
+ items: *869
source_url:
type: string
format: uri
@@ -170842,7 +170201,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -171023,12 +170382,12 @@ webhooks:
- duration
- created_at
- updated_at
- enterprise: *833
+ enterprise: *828
id:
type: integer
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- id
@@ -171105,7 +170464,7 @@ webhooks:
type: string
enum:
- approved
- personal_access_token_request: &875
+ personal_access_token_request: &870
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -171255,10 +170614,10 @@ webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *833
- organization: *835
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171335,11 +170694,11 @@ webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *875
- enterprise: *833
- organization: *835
+ personal_access_token_request: *870
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171415,11 +170774,11 @@ webhooks:
type: string
enum:
- created
- personal_access_token_request: *875
- enterprise: *833
- organization: *835
+ personal_access_token_request: *870
+ enterprise: *828
+ organization: *830
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171494,11 +170853,11 @@ webhooks:
type: string
enum:
- denied
- personal_access_token_request: *875
- organization: *835
- enterprise: *833
+ personal_access_token_request: *870
+ organization: *830
+ enterprise: *828
sender: *4
- installation: *834
+ installation: *829
required:
- action
- personal_access_token_request
@@ -171603,7 +170962,7 @@ webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *876
+ last_response: *871
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -171635,8 +170994,8 @@ webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
zen:
description: Random string of GitHub zen.
@@ -171881,10 +171240,10 @@ webhooks:
- from
required:
- note
- enterprise: *833
- installation: *834
- organization: *835
- project_card: &877
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: &872
title: Project Card
type: object
properties:
@@ -172007,7 +171366,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172088,11 +171447,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project_card: *877
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: *872
+ repository: *831
sender: *4
required:
- action
@@ -172172,9 +171531,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
project_card:
title: Project Card
type: object
@@ -172304,7 +171663,7 @@ webhooks:
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -172398,11 +171757,11 @@ webhooks:
- from
required:
- note
- enterprise: *833
- installation: *834
- organization: *835
- project_card: *877
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_card: *872
+ repository: *831
sender: *4
required:
- action
@@ -172496,9 +171855,9 @@ webhooks:
- from
required:
- column_id
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
project_card:
allOf:
- title: Project Card
@@ -172695,7 +172054,7 @@ webhooks:
type: string
required:
- after_id
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172775,10 +172134,10 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- organization: *835
- project: &879
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: &874
title: Project
type: object
properties:
@@ -172905,7 +172264,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -172985,10 +172344,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project_column: &878
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: &873
title: Project Column
type: object
properties:
@@ -173028,7 +172387,7 @@ webhooks:
- name
- created_at
- updated_at
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -173107,14 +172466,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -173203,11 +172562,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
+ repository: *831
sender: *4
required:
- action
@@ -173287,11 +172646,11 @@ webhooks:
type: string
enum:
- moved
- enterprise: *833
- installation: *834
- organization: *835
- project_column: *878
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project_column: *873
+ repository: *831
sender: *4
required:
- action
@@ -173371,11 +172730,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173455,14 +172814,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
repository:
anyOf:
- type: 'null'
- - *836
+ - *831
sender: *4
required:
- action
@@ -173563,11 +172922,11 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173646,11 +173005,11 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
- organization: *835
- project: *879
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ project: *874
+ repository: *831
sender: *4
required:
- action
@@ -173731,8 +173090,8 @@ webhooks:
type: string
enum:
- closed
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -173814,8 +173173,8 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -173897,8 +173256,8 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174020,8 +173379,8 @@ webhooks:
type: string
to:
type: string
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174105,7 +173464,7 @@ webhooks:
type: string
enum:
- archived
- changes: &883
+ changes: &878
type: object
properties:
archived_at:
@@ -174121,9 +173480,9 @@ webhooks:
- string
- 'null'
format: date-time
- installation: *834
- organization: *835
- projects_v2_item: &880
+ installation: *829
+ organization: *830
+ projects_v2_item: &875
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -174263,9 +173622,9 @@ webhooks:
- 'null'
to:
type: string
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174347,9 +173706,9 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174430,9 +173789,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174537,7 +173896,7 @@ webhooks:
oneOf:
- type: string
- type: integer
- - &881
+ - &876
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -174561,7 +173920,7 @@ webhooks:
required:
- id
- name
- - &882
+ - &877
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -174601,8 +173960,8 @@ webhooks:
oneOf:
- type: string
- type: integer
- - *881
- - *882
+ - *876
+ - *877
type:
- 'null'
- string
@@ -174625,9 +173984,9 @@ webhooks:
- 'null'
required:
- body
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174724,9 +174083,9 @@ webhooks:
type:
- string
- 'null'
- installation: *834
- organization: *835
- projects_v2_item: *880
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174809,10 +174168,10 @@ webhooks:
type: string
enum:
- restored
- changes: *883
- installation: *834
- organization: *835
- projects_v2_item: *880
+ changes: *878
+ installation: *829
+ organization: *830
+ projects_v2_item: *875
sender: *4
required:
- action
@@ -174894,8 +174253,8 @@ webhooks:
type: string
enum:
- reopened
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
projects_v2: *389
sender: *4
required:
@@ -174977,9 +174336,9 @@ webhooks:
type: string
enum:
- created
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175060,9 +174419,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175208,9 +174567,9 @@ webhooks:
- string
- 'null'
format: date
- installation: *834
- organization: *835
- projects_v2_status_update: *884
+ installation: *829
+ organization: *830
+ projects_v2_status_update: *879
sender: *4
required:
- action
@@ -175281,10 +174640,10 @@ webhooks:
title: public event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- repository
@@ -175361,13 +174720,13 @@ webhooks:
type: string
enum:
- assigned
- assignee: *860
- enterprise: *833
- installation: *834
- number: &885
+ assignee: *855
+ enterprise: *828
+ installation: *829
+ number: &880
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -177716,7 +177075,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -177798,11 +177157,11 @@ webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -180144,7 +179503,7 @@ webhooks:
- draft
reason:
type: string
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -180226,11 +179585,11 @@ webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -182572,7 +181931,7 @@ webhooks:
- draft
reason:
type: string
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -182654,13 +182013,13 @@ webhooks:
type: string
enum:
- closed
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: &886
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: &881
allOf:
- - *678
+ - *675
- type: object
properties:
allow_auto_merge:
@@ -182722,7 +182081,7 @@ webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -182803,12 +182162,12 @@ webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -182888,11 +182247,11 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *833
+ enterprise: *828
milestone: *392
- number: *885
- organization: *835
- pull_request: &887
+ number: *880
+ organization: *830
+ pull_request: &882
title: Pull Request
type: object
properties:
@@ -185219,7 +184578,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -185298,11 +184657,11 @@ webhooks:
type: string
enum:
- dequeued
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -187648,7 +187007,7 @@ webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -187772,12 +187131,12 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -187857,11 +187216,11 @@ webhooks:
type: string
enum:
- enqueued
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -190192,7 +189551,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -190272,11 +189631,11 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *833
- installation: *834
- label: *854
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ label: *849
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -192624,7 +191983,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -192705,10 +192064,10 @@ webhooks:
type: string
enum:
- locked
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -195054,7 +194413,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -195134,12 +194493,12 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *833
+ enterprise: *828
milestone: *392
- number: *885
- organization: *835
- pull_request: *887
- repository: *836
+ number: *880
+ organization: *830
+ pull_request: *882
+ repository: *831
sender: *4
required:
- action
@@ -195218,12 +194577,12 @@ webhooks:
type: string
enum:
- opened
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195304,12 +194663,12 @@ webhooks:
type: string
enum:
- ready_for_review
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195389,12 +194748,12 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
- pull_request: *886
- repository: *836
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
+ pull_request: *881
+ repository: *831
sender: *4
required:
- action
@@ -195769,9 +195128,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -198001,7 +197360,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -198081,7 +197440,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &889
+ comment: &884
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.
@@ -198374,9 +197733,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -200594,7 +199953,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -200674,11 +200033,11 @@ webhooks:
type: string
enum:
- edited
- changes: *888
- comment: *889
- enterprise: *833
- installation: *834
- organization: *835
+ changes: *883
+ comment: *884
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
type: object
properties:
@@ -202899,7 +202258,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -202980,9 +202339,9 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -205215,7 +204574,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
review:
description: The review that was affected.
type: object
@@ -205466,9 +204825,9 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -207582,8 +206941,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
- review: &890
+ repository: *831
+ review: &885
description: The review that was affected.
type: object
properties:
@@ -207821,12 +207180,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -210173,7 +209532,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_reviewer:
title: User
type:
@@ -210259,12 +209618,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -212618,7 +211977,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -212813,12 +212172,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -215167,7 +214526,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_reviewer:
title: User
type:
@@ -215254,12 +214613,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *833
- installation: *834
+ enterprise: *828
+ installation: *829
number:
description: The pull request number.
type: integer
- organization: *835
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -217599,7 +216958,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -217783,9 +217142,9 @@ webhooks:
type: string
enum:
- submitted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -220021,8 +219380,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
- review: *890
+ repository: *831
+ review: *885
sender: *4
required:
- action
@@ -220102,9 +219461,9 @@ webhooks:
type: string
enum:
- resolved
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -222235,7 +221594,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
thread:
type: object
@@ -222632,9 +221991,9 @@ webhooks:
type: string
enum:
- unresolved
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
pull_request:
title: Simple Pull Request
type: object
@@ -224748,7 +224107,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *836
+ repository: *831
sender: *4
thread:
type: object
@@ -225147,10 +224506,10 @@ webhooks:
type: string
before:
type: string
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -227485,7 +226844,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -227567,11 +226926,11 @@ webhooks:
type: string
enum:
- unassigned
- assignee: *891
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ assignee: *886
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -229921,7 +229280,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -230000,11 +229359,11 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *833
- installation: *834
- label: *854
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ label: *849
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -232343,7 +231702,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -232424,10 +231783,10 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *833
- installation: *834
- number: *885
- organization: *835
+ enterprise: *828
+ installation: *829
+ number: *880
+ organization: *830
pull_request:
title: Pull Request
type: object
@@ -234756,7 +234115,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -234959,7 +234318,7 @@ webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *833
+ enterprise: *828
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -235054,8 +234413,8 @@ webhooks:
- url
- author
- committer
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -235643,9 +235002,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
registry_package:
type: object
properties:
@@ -236122,7 +235481,7 @@ webhooks:
type: string
rubygems_metadata:
type: array
- items: *874
+ items: *869
summary:
type: string
tag_name:
@@ -236178,7 +235537,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -236256,9 +235615,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
registry_package:
type: object
properties:
@@ -236570,7 +235929,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *874
+ items: *869
summary:
type: string
tag_name:
@@ -236620,7 +235979,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -236697,10 +236056,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- release: &892
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: &887
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -237031,7 +236390,7 @@ webhooks:
- updated_at
- zipball_url
- body
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -237108,11 +236467,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -237229,11 +236588,11 @@ webhooks:
type: boolean
required:
- to
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -237311,9 +236670,9 @@ webhooks:
type: string
enum:
- prereleased
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -237649,7 +237008,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -237725,10 +237084,10 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- release: &893
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: &888
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -238061,7 +237420,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *836
+ repository: *831
sender: *4
required:
- action
@@ -238137,11 +237496,11 @@ webhooks:
type: string
enum:
- released
- enterprise: *833
- installation: *834
- organization: *835
- release: *892
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *887
+ repository: *831
sender: *4
required:
- action
@@ -238217,11 +237576,11 @@ webhooks:
type: string
enum:
- unpublished
- enterprise: *833
- installation: *834
- organization: *835
- release: *893
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ release: *888
+ repository: *831
sender: *4
required:
- action
@@ -238297,11 +237656,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- repository_advisory: *730
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ repository_advisory: *727
sender: *4
required:
- action
@@ -238377,11 +237736,11 @@ webhooks:
type: string
enum:
- reported
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- repository_advisory: *730
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ repository_advisory: *727
sender: *4
required:
- action
@@ -238457,10 +237816,10 @@ webhooks:
type: string
enum:
- archived
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238537,10 +237896,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238618,10 +237977,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238706,10 +238065,10 @@ webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238824,10 +238183,10 @@ webhooks:
- 'null'
items:
type: string
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -238899,10 +238258,10 @@ webhooks:
title: repository_import event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
status:
type: string
@@ -238983,10 +238342,10 @@ webhooks:
type: string
enum:
- privatized
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239063,10 +238422,10 @@ webhooks:
type: string
enum:
- publicized
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239160,10 +238519,10 @@ webhooks:
- name
required:
- repository
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239243,10 +238602,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
sender: *4
required:
@@ -239325,10 +238684,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
sender: *4
required:
@@ -239407,10 +238766,10 @@ webhooks:
type: string
enum:
- edited
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
repository_ruleset: *184
changes:
type: object
@@ -239472,16 +238831,16 @@ webhooks:
properties:
added:
type: array
- items: *698
+ items: *695
deleted:
type: array
- items: *698
+ items: *695
updated:
type: array
items:
type: object
properties:
- rule: *698
+ rule: *695
changes:
type: object
properties:
@@ -239718,10 +239077,10 @@ webhooks:
- from
required:
- owner
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239799,10 +239158,10 @@ webhooks:
type: string
enum:
- unarchived
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -239880,7 +239239,7 @@ webhooks:
type: string
enum:
- create
- alert: &894
+ alert: &889
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -240004,10 +239363,10 @@ webhooks:
type: string
enum:
- open
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240217,10 +239576,10 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240298,11 +239657,11 @@ webhooks:
type: string
enum:
- reopen
- alert: *894
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *889
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240504,10 +239863,10 @@ webhooks:
enum:
- fixed
- open
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240585,7 +239944,7 @@ webhooks:
type: string
enum:
- assigned
- alert: &895
+ alert: &890
type: object
properties:
number: *123
@@ -240700,10 +240059,10 @@ webhooks:
- type: 'null'
- *4
assignee: *4
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240781,11 +240140,11 @@ webhooks:
type: string
enum:
- created
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -240866,11 +240225,11 @@ webhooks:
type: string
enum:
- created
- alert: *895
- installation: *834
- location: *896
- organization: *835
- repository: *836
+ alert: *890
+ installation: *829
+ location: *891
+ organization: *830
+ repository: *831
sender: *4
required:
- location
@@ -241108,11 +240467,11 @@ webhooks:
type: string
enum:
- publicly_leaked
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241190,11 +240549,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241272,11 +240631,11 @@ webhooks:
type: string
enum:
- resolved
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241354,12 +240713,12 @@ webhooks:
type: string
enum:
- unassigned
- alert: *895
+ alert: *890
assignee: *4
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241437,11 +240796,11 @@ webhooks:
type: string
enum:
- validated
- alert: *895
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ alert: *890
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -241571,10 +240930,10 @@ webhooks:
- organization
- enterprise
-
- repository: *836
- enterprise: *833
- installation: *834
- organization: *835
+ repository: *831
+ enterprise: *828
+ installation: *829
+ organization: *830
sender: *4
required:
- action
@@ -241652,11 +241011,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- security_advisory: &897
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ security_advisory: &892
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -241842,11 +241201,11 @@ webhooks:
type: string
enum:
- updated
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
- security_advisory: *897
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
+ security_advisory: *892
sender: *4
required:
- action
@@ -241919,10 +241278,10 @@ webhooks:
type: string
enum:
- withdrawn
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -242109,10 +241468,10 @@ webhooks:
type: object
properties:
security_and_analysis: *402
- enterprise: *833
- installation: *834
- organization: *835
- repository: *449
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *446
sender: *4
required:
- changes
@@ -242190,12 +241549,12 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: &898
+ sponsorship: &893
type: object
properties:
created_at:
@@ -242500,12 +241859,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- sponsorship
@@ -242593,12 +241952,12 @@ webhooks:
type: string
required:
- from
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242675,17 +242034,17 @@ webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &899
+ effective_date: &894
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: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- sponsorship
@@ -242759,7 +242118,7 @@ webhooks:
type: string
enum:
- pending_tier_change
- changes: &900
+ changes: &895
type: object
properties:
tier:
@@ -242803,13 +242162,13 @@ webhooks:
- from
required:
- tier
- effective_date: *899
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ effective_date: *894
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242886,13 +242245,13 @@ webhooks:
type: string
enum:
- tier_changed
- changes: *900
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ changes: *895
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- sponsorship: *898
+ sponsorship: *893
required:
- action
- changes
@@ -242966,10 +242325,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -243053,10 +242412,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -243490,15 +242849,15 @@ webhooks:
type:
- string
- 'null'
- enterprise: *833
+ enterprise: *828
id:
description: The unique identifier of the status.
type: integer
- installation: *834
+ installation: *829
name:
type: string
- organization: *835
- repository: *836
+ organization: *830
+ repository: *831
sender: *4
sha:
description: The Commit SHA.
@@ -243614,9 +242973,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243706,9 +243065,9 @@ webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243798,9 +243157,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243890,9 +243249,9 @@ webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *212
- installation: *834
- organization: *835
- repository: *836
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -243969,12 +243328,12 @@ webhooks:
title: team_add event
type: object
properties:
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- team: &901
+ team: &896
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -244204,9 +243563,9 @@ webhooks:
type: string
enum:
- added_to_repository
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -244676,7 +244035,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -244752,9 +244111,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -245224,7 +244583,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -245301,9 +244660,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -245773,7 +245132,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -245917,9 +245276,9 @@ webhooks:
- from
required:
- permissions
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -246389,7 +245748,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- changes
@@ -246467,9 +245826,9 @@ webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *833
- installation: *834
- organization: *835
+ enterprise: *828
+ installation: *829
+ organization: *830
repository:
title: Repository
description: A git repository
@@ -246939,7 +246298,7 @@ webhooks:
- topics
- visibility
sender: *4
- team: *901
+ team: *896
required:
- action
- team
@@ -247015,10 +246374,10 @@ webhooks:
type: string
enum:
- started
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
required:
- action
@@ -247091,17 +246450,17 @@ webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *833
+ enterprise: *828
inputs:
type:
- object
- 'null'
additionalProperties: true
- installation: *834
- organization: *835
+ installation: *829
+ organization: *830
ref:
type: string
- repository: *836
+ repository: *831
sender: *4
workflow:
type: string
@@ -247183,10 +246542,10 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
allOf:
@@ -247442,7 +246801,7 @@ webhooks:
type: string
required:
- conclusion
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -247521,10 +246880,10 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
allOf:
@@ -247806,7 +247165,7 @@ webhooks:
required:
- status
- steps
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -247885,10 +247244,10 @@ webhooks:
type: string
enum:
- queued
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
type: object
@@ -248034,7 +247393,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -248113,10 +247472,10 @@ webhooks:
type: string
enum:
- waiting
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
workflow_job:
type: object
@@ -248263,7 +247622,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *583
+ deployment: *580
required:
- action
- repository
@@ -248343,12 +247702,12 @@ webhooks:
type: string
enum:
- completed
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
@@ -249367,12 +248726,12 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
@@ -250376,12 +249735,12 @@ webhooks:
type: string
enum:
- requested
- enterprise: *833
- installation: *834
- organization: *835
- repository: *836
+ enterprise: *828
+ installation: *829
+ organization: *830
+ repository: *831
sender: *4
- workflow: *850
+ workflow: *845
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json
index aab84d67e..0e7ec099f 100644
--- a/descriptions-next/ghec/ghec.2022-11-28.json
+++ b/descriptions-next/ghec/ghec.2022-11-28.json
@@ -41145,307 +41145,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",
@@ -80993,307 +80692,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)",
@@ -143691,19 +143089,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -143789,8 +143174,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -143804,115 +143187,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "$ref": "#/components/schemas/simple-user"
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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",
@@ -323917,8 +323191,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",
@@ -323970,8 +323242,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",
@@ -324022,8 +323292,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",
@@ -324049,149 +323317,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": {
@@ -346111,15 +345236,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-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml
index 814057abd..513ecd7bd 100644
--- a/descriptions-next/ghec/ghec.2022-11-28.yaml
+++ b/descriptions-next/ghec/ghec.2022-11-28.yaml
@@ -29655,217 +29655,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
@@ -58547,227 +58336,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)
@@ -104087,15 +103655,6 @@ components:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -104158,8 +103717,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -104171,85 +103728,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:
- anyOf:
- - type: 'null'
- - "$ref": "#/components/schemas/simple-user"
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - 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
@@ -239011,8 +238489,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
@@ -239059,8 +238535,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
@@ -239107,8 +238581,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
@@ -239131,135 +238603,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:
@@ -258134,13 +257477,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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json
index aab84d67e..0e7ec099f 100644
--- a/descriptions-next/ghec/ghec.json
+++ b/descriptions-next/ghec/ghec.json
@@ -41145,307 +41145,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",
@@ -80993,307 +80692,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)",
@@ -143691,19 +143089,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -143789,8 +143174,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -143804,115 +143187,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "$ref": "#/components/schemas/simple-user"
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "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",
@@ -323917,8 +323191,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",
@@ -323970,8 +323242,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",
@@ -324022,8 +323292,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",
@@ -324049,149 +323317,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": {
@@ -346111,15 +345236,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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml
index 814057abd..513ecd7bd 100644
--- a/descriptions-next/ghec/ghec.yaml
+++ b/descriptions-next/ghec/ghec.yaml
@@ -29655,217 +29655,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
@@ -58547,227 +58336,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)
@@ -104087,15 +103655,6 @@ components:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -104158,8 +103717,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -104171,85 +103728,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:
- anyOf:
- - type: 'null'
- - "$ref": "#/components/schemas/simple-user"
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - 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
@@ -239011,8 +238489,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
@@ -239059,8 +238535,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
@@ -239107,8 +238581,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
@@ -239131,135 +238603,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:
@@ -258134,13 +257477,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-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
index e99df13bf..4519d2c70 100644
--- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
+++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
@@ -215709,19 +215709,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -215853,8 +215840,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -215896,8 +215881,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",
@@ -216217,19 +216200,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -216361,8 +216331,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -216402,8 +216370,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",
@@ -216689,19 +216655,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -216833,8 +216786,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -216874,8 +216825,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",
@@ -217185,19 +217134,6 @@
"0307116bbf7ced493b8d8a346c650b71"
]
},
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -217329,8 +217265,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -217370,8 +217304,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",
@@ -217462,17 +217394,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-server@3.14/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-server@3.14/rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -217492,28 +217424,421 @@
"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",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "type": "string",
+ "examples": [
+ "2019-06-03 22:27:15:000 -700"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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": "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",
+ "examples": [
+ 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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "type": "string",
+ "examples": [
+ "group-azuread-test"
+ ]
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "type": "string",
+ "examples": [
+ "2021-01-03 22:27:15:000 -700"
+ ]
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "type": "string",
+ "examples": [
+ "team-test"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ]
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "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",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "type": "string",
+ "examples": [
+ "mona-lisa_eocsaxrs"
+ ]
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "type": "string",
+ "examples": [
+ "Mona Lisa"
+ ]
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "type": "string",
+ "examples": [
+ "mona_lisa@github.com"
+ ]
+ }
+ }
+ },
+ "examples": [
+ {
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "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": "direction",
- "description": "The direction to sort the results by.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/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-server@3.14/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": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -217543,322 +217868,170 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
+ "name": {
+ "type": [
+ "string",
+ "null"
]
},
- "body": {
- "description": "The main text of the comment.",
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "octocat"
]
},
- "body_html": {
- "type": "string",
+ "id": {
+ "type": "integer",
+ "format": "int64",
"examples": [
- "Do you like apples?
"
+ 1
]
},
- "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.",
+ "node_id": {
"type": "string",
"examples": [
- "0307116bbf7ced493b8d8a346c650b71"
+ "MDQ6VXNlcjE="
]
},
- "created_at": {
+ "avatar_url": {
"type": "string",
- "format": "date-time",
+ "format": "uri",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://github.com/images/error/octocat_happy.gif"
]
},
- "last_edited_at": {
+ "gravatar_id": {
"type": [
"string",
"null"
],
- "format": "date-time"
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "https://api.github.com/users/octocat"
]
},
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/octocat"
]
},
- "node_id": {
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "https://api.github.com/users/octocat/followers"
]
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
+ "following_url": {
+ "type": "string",
"examples": [
- 42
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
]
},
- "url": {
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "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",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
},
"required": [
- "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"
]
}
@@ -217867,49 +218040,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
}
]
}
@@ -217930,19 +218078,126 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "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",
+ "type": "string",
+ "examples": [
+ "member"
+ ]
+ },
+ "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"
}
},
- "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.",
+ "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/create-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-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -217964,35 +218219,38 @@
}
},
{
- "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"
}
}
],
"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"
}
}
}
@@ -218000,403 +218258,83 @@
}
},
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
+ "url": {
"type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "format": "uri"
},
- "last_edited_at": {
- "type": [
- "string",
- "null"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
+ "default": "member",
"type": "string",
- "format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "member"
]
},
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "examples": [
- "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": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- }
- },
- "/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.",
+ },
+ "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/get-discussion-comment-in-org",
+ "operationId": "teams/remove-membership-for-user-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/members#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -218418,21 +218356,78 @@
}
},
{
- "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": {
+ "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": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "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
}
}
],
@@ -218442,329 +218437,652 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
+ "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",
+ "null"
+ ]
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
},
- "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"
- ]
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
+ ]
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "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": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Project",
+ "description": "A team's access to a project.",
+ "type": "object",
+ "properties": {
+ "owner_url": {
+ "type": "string"
},
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
+ "url": {
+ "type": "string"
},
- "body_html": {
- "type": "string",
- "examples": [
- "Do you like apples?
"
- ]
+ "html_url": {
+ "type": "string"
},
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
+ "columns_url": {
+ "type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "id": {
+ "type": "integer"
},
- "last_edited_at": {
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
"type": [
"string",
"null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
+ "type": "integer"
},
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- ]
+ "state": {
+ "type": "string"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "creator": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
"type": "object",
"properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
},
- "total_count": {
- "type": "integer"
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
},
- "+1": {
- "type": "integer"
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
},
- "-1": {
- "type": "integer"
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
},
- "laugh": {
- "type": "integer"
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
},
- "confused": {
- "type": "integer"
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
},
- "heart": {
- "type": "integer"
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
},
- "hooray": {
- "type": "integer"
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
},
- "rocket": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
+ ]
}
},
"required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "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": [
- "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=",
@@ -218784,53 +219102,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": [
{
@@ -218852,17 +219162,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": {
@@ -218871,25 +219172,31 @@
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
- "type": "object",
+ "type": [
+ "object",
+ "null"
+ ],
"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"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Updates the permissions for the team to write for the project",
"value": {
- "body": "Do you like pineapples?"
+ "permission": "write"
}
}
}
@@ -218897,376 +219204,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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the comment.",
- "type": "string",
- "examples": [
- "I agree with this suggestion."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-15T23:53:58Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- ]
+ "message": {
+ "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"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "documentation_url": {
+ "type": "string"
}
- },
- "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"
}
}
}
@@ -219278,19 +219238,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": [
{
@@ -219312,17 +219275,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": {
@@ -219339,21 +219293,24 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"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.",
+ "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-linked-external-idp-groups-to-team-for-org",
+ "operationId": "teams/list-repos-in-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"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -219373,6 +219330,24 @@
"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": {
@@ -219381,1267 +219356,818 @@
"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",
- "type": "array",
- "items": {
+ "type": "array",
+ "items": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "examples": [
+ 1296269
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "examples": [
+ "Hello-World"
+ ]
+ },
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
+ ]
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
"type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
"properties": {
- "group_id": {
- "description": "The internal ID of the group",
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
"type": "integer",
+ "format": "int64",
"examples": [
1
]
},
- "group_name": {
- "description": "The display name of the group",
+ "node_id": {
"type": "string",
"examples": [
- "group-azuread-test"
+ "MDQ6VXNlcjE="
]
},
- "updated_at": {
- "description": "The time of the last update for this group",
+ "avatar_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "2019-06-03 22:27:15:000 -700"
+ "https://github.com/images/error/octocat_happy.gif"
]
- }
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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",
- "examples": [
- 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",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "group_name": {
- "description": "The display name for the group",
- "type": "string",
- "examples": [
- "group-azuread-test"
- ]
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "type": "string",
- "examples": [
- "2021-01-03 22:27:15:000 -700"
- ]
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "type": "integer",
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- 1
+ "41d064eb2195891e12d0413f63227ea7"
]
},
- "team_name": {
- "description": "The name of the team",
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "team-test"
+ "https://api.github.com/users/octocat"
]
- }
- }
- },
- "examples": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ]
- },
- "members": {
- "description": "An array of external members linked to this group",
- "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",
- "type": "integer",
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
"examples": [
- 1
+ "https://github.com/octocat"
]
},
- "member_login": {
- "description": "The handle/login for the user",
+ "followers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "mona-lisa_eocsaxrs"
+ "https://api.github.com/users/octocat/followers"
]
},
- "member_name": {
- "description": "The user display name/profile name",
+ "following_url": {
"type": "string",
"examples": [
- "Mona Lisa"
+ "https://api.github.com/users/octocat/following{/other_user}"
]
},
- "member_email": {
- "description": "An email attached to a user",
+ "gists_url": {
"type": "string",
"examples": [
- "mona_lisa@github.com"
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ },
+ "user_view_type": {
+ "type": "string",
+ "examples": [
+ "public"
]
}
- }
- },
- "examples": [
- {
- "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"
- }
- ]
- }
- }
- },
- "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"
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- }
- },
- "/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-server@3.14/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-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": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
+ "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"
]
},
- "email": {
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat/Hello-World"
+ ]
+ },
+ "description": {
"type": [
"string",
"null"
+ ],
+ "examples": [
+ "This your first repo!"
]
},
- "login": {
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
+ "format": "uri",
"examples": [
- "octocat"
+ "https://api.github.com/repos/octocat/Hello-World"
]
},
- "id": {
- "type": "integer",
- "format": "int64",
+ "archive_url": {
+ "type": "string",
"examples": [
- 1
+ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
]
},
- "node_id": {
+ "assignees_url": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
+ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
]
},
- "avatar_url": {
+ "blobs_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ ]
+ },
+ "branches_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ ]
+ },
+ "collaborators_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ ]
+ },
+ "commits_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ ]
+ },
+ "compare_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ ]
+ },
+ "contents_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ ]
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/images/error/octocat_happy.gif"
+ "http://api.github.com/repos/octocat/Hello-World/contributors"
]
},
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
"examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "http://api.github.com/repos/octocat/Hello-World/deployments"
]
},
- "url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/downloads"
]
},
- "html_url": {
+ "events_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/octocat"
+ "http://api.github.com/repos/octocat/Hello-World/events"
]
},
- "followers_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "http://api.github.com/repos/octocat/Hello-World/forks"
]
},
- "following_url": {
+ "git_commits_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
]
},
- "gists_url": {
+ "git_refs_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
]
},
- "starred_url": {
+ "git_tags_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
]
},
- "subscriptions_url": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
]
},
- "organizations_url": {
+ "issue_events_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ ]
+ },
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ ]
+ },
+ "keys_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ ]
+ },
+ "labels_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ ]
+ },
+ "languages_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "http://api.github.com/repos/octocat/Hello-World/languages"
]
},
- "repos_url": {
+ "merges_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "http://api.github.com/repos/octocat/Hello-World/merges"
]
},
- "events_url": {
+ "milestones_url": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
]
},
- "received_events_url": {
+ "notifications_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
]
},
- "type": {
+ "pulls_url": {
"type": "string",
"examples": [
- "User"
+ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
]
},
- "site_admin": {
- "type": "boolean"
+ "releases_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ ]
},
- "starred_at": {
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
"type": "string",
+ "format": "uri",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ "http://api.github.com/repos/octocat/Hello-World/stargazers"
]
},
- "user_view_type": {
+ "statuses_url": {
"type": "string",
"examples": [
- "public"
+ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
]
- }
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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",
- "type": "string",
- "examples": [
- "member"
- ]
- },
- "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"
},
- "url": {
- "type": "string"
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ ]
},
- "html_url": {
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/subscription"
+ ]
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/tags"
+ ]
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/teams"
+ ]
+ },
+ "trees_url": {
+ "type": "string",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ ]
+ },
+ "clone_url": {
"type": "string"
},
- "columns_url": {
+ "mirror_url": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "http://api.github.com/repos/octocat/Hello-World/hooks"
+ ]
+ },
+ "svn_url": {
"type": "string"
},
- "id": {
+ "homepage": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "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",
"null"
+ ],
+ "format": "date-time",
+ "examples": [
+ "2011-01-26T19:06:43Z"
]
},
- "number": {
- "type": "integer"
+ "created_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "examples": [
+ "2011-01-26T19:01:12Z"
+ ]
},
- "state": {
- "type": "string"
+ "updated_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "examples": [
+ "2011-01-26T19:14:43Z"
+ ]
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "permissions": {
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
+ "admin": {
+ "type": "boolean"
},
- "email": {
- "type": [
- "string",
- "null"
- ]
+ "maintain": {
+ "type": "boolean"
},
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
+ "push": {
+ "type": "boolean"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
+ "triage": {
+ "type": "boolean"
},
- "node_id": {
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "examples": [
+ "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",
"examples": [
- "MDQ6VXNlcjE="
+ "contributor_covenant"
]
},
- "avatar_url": {
+ "name": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "Contributor Covenant"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
+ "https://api.github.com/codes_of_conduct/contributor_covenant"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
+ "body": {
"type": "string",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ "# 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"
]
},
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
+ "html_url": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "uri"
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
+ "url",
"html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "key",
+ "name"
]
},
- "created_at": {
- "type": "string"
+ "license": {
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ }
},
- "updated_at": {
- "type": "string"
+ "forks": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
},
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
- "type": "string"
+ "open_issues": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
},
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "watchers": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "allow_forking": {
"type": "boolean"
},
- "permissions": {
- "type": "object",
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "security_and_analysis": {
+ "type": [
+ "object",
+ "null"
+ ],
"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"
]
}
},
@@ -220649,17 +220175,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=",
@@ -220679,505 +220199,106 @@
"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": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "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",
- "null"
- ]
- },
- "number": {
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "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"
+ "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
},
- "admin": {
- "type": "boolean"
+ "security_and_analysis": {
+ "advanced_security": {
+ "status": "enabled"
+ },
+ "secret_scanning": {
+ "status": "enabled"
+ },
+ "secret_scanning_push_protection": {
+ "status": "disabled"
+ }
}
- },
- "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
}
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Not Found if project is not managed by this team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "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/add-or-update-project-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"
- },
- "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": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": [
- "object",
- "null"
- ],
- "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"
]
}
}
- },
- "examples": {
- "default": {
- "summary": "Updates the permissions for the team to write for the project",
- "value": {
- "permission": "write"
- }
- }
}
- }
- }
- },
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if the project is not owned by the organization",
- "content": {
- "application/json": {
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
"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"
- }
- }
+ "type": "string"
}
}
}
@@ -221187,22 +220308,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "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.",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/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}`.",
"tags": [
"teams"
],
- "operationId": "teams/remove-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#remove-a-project-from-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository"
},
"parameters": [
{
@@ -221224,47 +220344,8 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "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}/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-server@3.14/rest/teams/teams#list-team-repositories"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
@@ -221272,1164 +220353,134 @@
}
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "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"
}
- },
- {
- "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",
+ "description": "Alternative response with repository permissions",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1296269
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Hello-World"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "examples": [
+ "Team Environment"
+ ]
+ },
+ "full_name": {
+ "type": "string",
+ "examples": [
+ "octocat/Hello-World"
+ ]
+ },
+ "license": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "examples": [
+ "mit"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "examples": [
+ "MIT License"
+ ]
+ },
+ "url": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/licenses/mit"
+ ]
+ },
+ "spdx_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "MIT"
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDc6TGljZW5zZW1pdA=="
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
},
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ]
+ }
+ ]
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
},
- "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",
- "examples": [
- "https://github.com/octocat/Hello-World"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "This your first repo!"
- ]
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/repos/octocat/Hello-World"
- ]
- },
- "archive_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- ]
- },
- "assignees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- ]
- },
- "blobs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- ]
- },
- "branches_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- ]
- },
- "collaborators_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- ]
- },
- "comments_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- ]
- },
- "commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- ]
- },
- "compare_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- ]
- },
- "contents_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- ]
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/contributors"
- ]
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/deployments"
- ]
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/downloads"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/events"
- ]
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/forks"
- ]
- },
- "git_commits_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- ]
- },
- "git_refs_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- ]
- },
- "git_tags_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- ]
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- ]
- },
- "issue_events_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- ]
- },
- "keys_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- ]
- },
- "labels_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- ]
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/languages"
- ]
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/merges"
- ]
- },
- "milestones_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- ]
- },
- "notifications_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- ]
- },
- "pulls_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- ]
- },
- "releases_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- ]
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
- ]
- },
- "statuses_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- ]
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
- ]
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/subscription"
- ]
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/tags"
- ]
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/teams"
- ]
- },
- "trees_url": {
- "type": "string",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- ]
- },
- "clone_url": {
- "type": "string"
- },
- "mirror_url": {
- "type": [
- "string",
- "null"
- ]
- },
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "http://api.github.com/repos/octocat/Hello-World/hooks"
- ]
- },
- "svn_url": {
- "type": "string"
- },
- "homepage": {
- "type": [
- "string",
- "null"
- ]
- },
- "language": {
- "type": [
- "string",
- "null"
- ]
- },
- "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",
- "null"
- ],
- "format": "date-time",
- "examples": [
- "2011-01-26T19:06:43Z"
- ]
- },
- "created_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time",
- "examples": [
- "2011-01-26T19:01:12Z"
- ]
- },
- "updated_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time",
- "examples": [
- "2011-01-26T19:14:43Z"
- ]
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- }
- },
- "role_name": {
- "type": "string",
- "examples": [
- "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",
- "examples": [
- "contributor_covenant"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "Contributor Covenant"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/codes_of_conduct/contributor_covenant"
- ]
- },
- "body": {
- "type": "string",
- "examples": [
- "# 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",
- "null"
- ],
- "format": "uri"
- }
- },
- "required": [
- "url",
- "html_url",
- "key",
- "name"
- ]
- },
- "license": {
- "type": [
- "object",
- "null"
- ],
- "properties": {
- "key": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "spdx_id": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "node_id": {
- "type": "string"
- }
- }
- },
- "forks": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "open_issues": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "watchers": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "allow_forking": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "security_and_analysis": {
- "type": [
- "object",
- "null"
- ],
- "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",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "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
- },
- "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
- },
- "security_and_analysis": {
- "advanced_security": {
- "status": "enabled"
- },
- "secret_scanning": {
- "status": "enabled"
- },
- "secret_scanning_push_protection": {
- "status": "disabled"
- }
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- }
- },
- "/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}`.",
- "tags": [
- "teams"
- ],
- "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-repository"
- },
- "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": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "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": "Alternative response with repository permissions",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Repository",
- "description": "A team's access to a repository.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the repository",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- ]
- },
- "name": {
- "description": "The name of the repository.",
- "type": "string",
- "examples": [
- "Team Environment"
- ]
- },
- "full_name": {
- "type": "string",
- "examples": [
- "octocat/Hello-World"
- ]
- },
- "license": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "examples": [
- "mit"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "MIT License"
- ]
- },
- "url": {
- "type": [
- "string",
- "null"
- ],
- "format": "uri",
- "examples": [
- "https://api.github.com/licenses/mit"
- ]
- },
- "spdx_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "MIT"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDc6TGljZW5zZW1pdA=="
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ]
- }
- ]
- },
- "forks": {
- "type": "integer"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- }
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
},
"required": [
"admin",
@@ -556239,3561 +554290,637 @@
"cas": {
"type": "object",
"properties": {
- "url": {
- "type": [
- "string",
- "null"
- ]
- }
- }
- },
- "saml": {
- "type": "object",
- "properties": {
- "sso_url": {
- "type": [
- "string",
- "null"
- ]
- },
- "certificate": {
- "type": [
- "string",
- "null"
- ]
- },
- "certificate_path": {
- "type": [
- "string",
- "null"
- ]
- },
- "issuer": {
- "type": [
- "string",
- "null"
- ]
- },
- "idp_initiated_sso": {
- "type": "boolean"
- },
- "disable_admin_demote": {
- "type": "boolean"
- }
- }
- },
- "github_oauth": {
- "type": "object",
- "properties": {
- "client_id": {
- "type": "string"
- },
- "client_secret": {
- "type": "string"
- },
- "organization_name": {
- "type": "string"
- },
- "organization_team": {
- "type": "string"
- }
- }
- },
- "smtp": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "address": {
- "type": "string"
- },
- "authentication": {
- "type": "string"
- },
- "port": {
- "type": "string"
- },
- "domain": {
- "type": "string"
- },
- "username": {
- "type": "string"
- },
- "user_name": {
- "type": "string"
- },
- "enable_starttls_auto": {
- "type": "boolean"
- },
- "password": {
- "type": "string"
- },
- "discard-to-noreply-address": {
- "type": "boolean"
- },
- "support_address": {
- "type": "string"
- },
- "support_address_type": {
- "type": "string"
- },
- "noreply_address": {
- "type": "string"
- }
- }
- },
- "ntp": {
- "type": "object",
- "properties": {
- "primary_server": {
- "type": "string"
- },
- "secondary_server": {
- "type": "string"
- }
- }
- },
- "timezone": {
- "type": [
- "string",
- "null"
- ]
- },
- "snmp": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "community": {
- "type": "string"
- }
- }
- },
- "syslog": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "server": {
- "type": [
- "string",
- "null"
- ]
- },
- "protocol_name": {
- "type": "string"
- }
- }
- },
- "assets": {
- "type": [
- "string",
- "null"
- ]
- },
- "pages": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- }
- },
- "collectd": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "server": {
- "type": [
- "string",
- "null"
- ]
- },
- "port": {
- "type": "integer"
- },
- "encryption": {
- "type": [
- "string",
- "null"
- ]
- },
- "username": {
- "type": [
- "string",
- "null"
- ]
- },
- "password": {
- "type": [
- "string",
- "null"
- ]
- }
- }
- },
- "mapping": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "tileserver": {
- "type": [
- "string",
- "null"
- ]
- },
- "basemap": {
- "type": "string"
- },
- "token": {
- "type": [
- "string",
- "null"
- ]
- }
- }
- },
- "load_balancer": {
- "type": [
- "string",
- "null"
- ]
- }
- }
- },
- "run_list": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "enterprise": {
- "private_mode": false,
- "public_pages": false,
- "subdomain_isolation": true,
- "signup_enabled": false,
- "github_hostname": "ghe.local",
- "identicons_host": "dotcom",
- "http_proxy": null,
- "auth_mode": "default",
- "expire_sessions": false,
- "admin_password": null,
- "configuration_id": 1401777404,
- "configuration_run_count": 4,
- "avatar": {
- "enabled": false,
- "uri": ""
- },
- "customer": {
- "name": "GitHub",
- "email": "stannis@themannis.biz",
- "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9",
- "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n",
- "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n"
- },
- "license": {
- "seats": 0,
- "evaluation": false,
- "perpetual": false,
- "unlimited_seating": true,
- "support_key": "ssh-rsa AAAAB3N....",
- "ssh_allowed": true,
- "cluster_support": false,
- "expire_at": "2016-04-27T00:00:00-07:00"
- },
- "github_ssl": {
- "enabled": false,
- "cert": null,
- "key": null
- },
- "ldap": {
- "host": null,
- "port": 0,
- "base": [],
- "uid": null,
- "bind_dn": null,
- "password": null,
- "method": "Plain",
- "search_strategy": "detect",
- "user_groups": [],
- "admin_group": null,
- "virtual_attribute_enabled": false,
- "recursive_group_search": false,
- "posix_support": true,
- "user_sync_emails": false,
- "user_sync_keys": false,
- "user_sync_interval": 4,
- "team_sync_interval": 4,
- "sync_enabled": false,
- "reconciliation": {
- "user": null,
- "org": null
- },
- "profile": {
- "uid": "uid",
- "name": null,
- "mail": null,
- "key": null
- }
- },
- "cas": {
- "url": null
- },
- "saml": {
- "sso_url": null,
- "certificate": null,
- "certificate_path": null,
- "issuer": null,
- "idp_initiated_sso": false,
- "disable_admin_demote": false
- },
- "github_oauth": {
- "client_id": "12313412",
- "client_secret": "kj123131132",
- "organization_name": "Homestar Runners",
- "organization_team": "homestarrunners/characters"
- },
- "smtp": {
- "enabled": true,
- "address": "smtp.example.com",
- "authentication": "plain",
- "port": "1234",
- "domain": "blah",
- "username": "foo",
- "user_name": "mr_foo",
- "enable_starttls_auto": true,
- "password": "bar",
- "discard-to-noreply-address": true,
- "support_address": "enterprise@github.com",
- "support_address_type": "email",
- "noreply_address": "noreply@github.com"
- },
- "ntp": {
- "primary_server": "0.pool.ntp.org",
- "secondary_server": "1.pool.ntp.org"
- },
- "timezone": null,
- "snmp": {
- "enabled": false,
- "community": ""
- },
- "syslog": {
- "enabled": false,
- "server": null,
- "protocol_name": "udp"
- },
- "assets": null,
- "pages": {
- "enabled": true
- },
- "collectd": {
- "enabled": false,
- "server": null,
- "port": 0,
- "encryption": null,
- "username": null,
- "password": null
- },
- "mapping": {
- "enabled": true,
- "tileserver": null,
- "basemap": "company.map-qsz2zrvs",
- "token": null
- },
- "load_balancer": null
- },
- "run_list": [
- "recipe[enterprise-configure]"
- ]
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- },
- "put": {
- "summary": "Set settings",
- "description": "Applies settings on your instance. 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).\n\n**Notes:**\n\n- 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).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"",
- "operationId": "enterprise-admin/set-settings",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "schema": {
- "type": "object",
- "properties": {
- "settings": {
- "type": "string",
- "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. 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": [
- "settings"
- ]
- },
- "examples": {
- "204": {
- "value": {
- "settings": "{ \"enterprise\": { \"public_pages\": true }}"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/setup/api/settings/authorized-keys": {
- "get": {
- "summary": "Get all authorized SSH keys",
- "description": "",
- "operationId": "enterprise-admin/get-all-authorized-ssh-keys",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys"
- },
- "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"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- },
- "post": {
- "summary": "Add 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/add-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#add-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": {
- "201": {
- "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"
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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",
- "null"
- ],
- "description": "The ID of a team to set as the parent team."
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
- },
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
- ]
- },
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
- },
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
- },
- "twitter_username": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
- ]
- },
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
- },
- "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",
- "null"
- ]
- },
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
- },
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 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"
- }
- }
- }
- }
- }
- },
- "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",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Developers"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "description": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "examples": [
- "notifications_enabled"
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "push"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "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",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
+ "url": {
+ "type": [
+ "string",
+ "null"
]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
+ }
+ }
+ },
+ "saml": {
+ "type": "object",
+ "properties": {
+ "sso_url": {
+ "type": [
+ "string",
+ "null"
]
},
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
+ "certificate": {
+ "type": [
+ "string",
+ "null"
]
},
- "description": {
- "description": "Description of the team",
+ "certificate_path": {
"type": [
"string",
"null"
- ],
- "examples": [
- "A great team."
]
},
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
+ "issuer": {
+ "type": [
+ "string",
+ "null"
]
},
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
+ "idp_initiated_sso": {
+ "type": "boolean"
},
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
+ "disable_admin_demote": {
+ "type": "boolean"
+ }
+ }
+ },
+ "github_oauth": {
+ "type": "object",
+ "properties": {
+ "client_id": {
+ "type": "string"
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
+ "client_secret": {
+ "type": "string"
},
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
+ "organization_name": {
+ "type": "string"
},
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
+ "organization_team": {
+ "type": "string"
+ }
+ }
+ },
+ "smtp": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
},
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,dc=github,dc=com"
- ]
+ "address": {
+ "type": "string"
},
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
+ "authentication": {
+ "type": "string"
},
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "examples": [
- 37
- ]
+ "port": {
+ "type": "string"
},
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
- ]
+ "domain": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "user_name": {
+ "type": "string"
+ },
+ "enable_starttls_auto": {
+ "type": "boolean"
+ },
+ "password": {
+ "type": "string"
+ },
+ "discard-to-noreply-address": {
+ "type": "boolean"
+ },
+ "support_address": {
+ "type": "string"
+ },
+ "support_address_type": {
+ "type": "string"
+ },
+ "noreply_address": {
+ "type": "string"
}
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ]
- }
- ]
- },
- "members_count": {
- "type": "integer",
- "examples": [
- 3
- ]
- },
- "repos_count": {
- "type": "integer",
- "examples": [
- 10
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-07-14T16:53:42Z"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2017-08-17T12:37:15Z"
- ]
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "id": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDEyOk9yZ2FuaXphdGlvbjE="
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/orgs/github/events"
- ]
- },
- "hooks_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/hooks"
- ]
- },
- "issues_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/issues"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/members{/member}"
- ]
- },
- "public_members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/orgs/github/public_members{/member}"
- ]
+ }
},
- "avatar_url": {
- "type": "string",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
+ "ntp": {
+ "type": "object",
+ "properties": {
+ "primary_server": {
+ "type": "string"
+ },
+ "secondary_server": {
+ "type": "string"
+ }
+ }
},
- "description": {
+ "timezone": {
"type": [
"string",
"null"
- ],
- "examples": [
- "A great organization"
- ]
- },
- "name": {
- "type": "string",
- "examples": [
- "github"
- ]
- },
- "company": {
- "type": "string",
- "examples": [
- "GitHub"
- ]
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/blog"
]
},
- "location": {
- "type": "string",
- "examples": [
- "San Francisco"
- ]
+ "snmp": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "community": {
+ "type": "string"
+ }
+ }
},
- "email": {
- "type": "string",
- "format": "email",
- "examples": [
- "octocat@github.com"
- ]
+ "syslog": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "server": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "protocol_name": {
+ "type": "string"
+ }
+ }
},
- "twitter_username": {
+ "assets": {
"type": [
"string",
"null"
- ],
- "examples": [
- "github"
- ]
- },
- "is_verified": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_organization_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "has_repository_projects": {
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "public_repos": {
- "type": "integer",
- "examples": [
- 2
- ]
- },
- "public_gists": {
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "followers": {
- "type": "integer",
- "examples": [
- 20
- ]
- },
- "following": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2008-01-14T04:33:35Z"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "Organization"
- ]
- },
- "total_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "owned_private_repos": {
- "type": "integer",
- "examples": [
- 100
- ]
- },
- "private_gists": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 81
- ]
- },
- "disk_usage": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 10000
- ]
- },
- "collaborators": {
- "type": [
- "integer",
- "null"
- ],
- "examples": [
- 8
]
},
- "billing_email": {
- "type": [
- "string",
- "null"
- ],
- "format": "email",
- "examples": [
- "org@example.com"
- ]
+ "pages": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
},
- "plan": {
+ "collectd": {
"type": "object",
"properties": {
- "name": {
- "type": "string"
+ "enabled": {
+ "type": "boolean"
},
- "space": {
- "type": "integer"
+ "server": {
+ "type": [
+ "string",
+ "null"
+ ]
},
- "private_repos": {
+ "port": {
"type": "integer"
},
- "filled_seats": {
- "type": "integer"
+ "encryption": {
+ "type": [
+ "string",
+ "null"
+ ]
},
- "seats": {
- "type": "integer"
+ "username": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "password": {
+ "type": [
+ "string",
+ "null"
+ ]
}
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
+ }
},
- "default_repository_permission": {
+ "mapping": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "tileserver": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "basemap": {
+ "type": "string"
+ },
+ "token": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ }
+ },
+ "load_balancer": {
"type": [
"string",
"null"
]
+ }
+ }
+ },
+ "run_list": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "enterprise": {
+ "private_mode": false,
+ "public_pages": false,
+ "subdomain_isolation": true,
+ "signup_enabled": false,
+ "github_hostname": "ghe.local",
+ "identicons_host": "dotcom",
+ "http_proxy": null,
+ "auth_mode": "default",
+ "expire_sessions": false,
+ "admin_password": null,
+ "configuration_id": 1401777404,
+ "configuration_run_count": 4,
+ "avatar": {
+ "enabled": false,
+ "uri": ""
},
- "members_can_create_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
+ "customer": {
+ "name": "GitHub",
+ "email": "stannis@themannis.biz",
+ "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9",
+ "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n",
+ "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n"
},
- "two_factor_requirement_enabled": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- true
- ]
+ "license": {
+ "seats": 0,
+ "evaluation": false,
+ "perpetual": false,
+ "unlimited_seating": true,
+ "support_key": "ssh-rsa AAAAB3N....",
+ "ssh_allowed": true,
+ "cluster_support": false,
+ "expire_at": "2016-04-27T00:00:00-07:00"
},
- "members_allowed_repository_creation_type": {
- "type": "string",
- "examples": [
- "all"
- ]
+ "github_ssl": {
+ "enabled": false,
+ "cert": null,
+ "key": null
},
- "members_can_create_public_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "ldap": {
+ "host": null,
+ "port": 0,
+ "base": [],
+ "uid": null,
+ "bind_dn": null,
+ "password": null,
+ "method": "Plain",
+ "search_strategy": "detect",
+ "user_groups": [],
+ "admin_group": null,
+ "virtual_attribute_enabled": false,
+ "recursive_group_search": false,
+ "posix_support": true,
+ "user_sync_emails": false,
+ "user_sync_keys": false,
+ "user_sync_interval": 4,
+ "team_sync_interval": 4,
+ "sync_enabled": false,
+ "reconciliation": {
+ "user": null,
+ "org": null
+ },
+ "profile": {
+ "uid": "uid",
+ "name": null,
+ "mail": null,
+ "key": null
+ }
},
- "members_can_create_private_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "cas": {
+ "url": null
},
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "saml": {
+ "sso_url": null,
+ "certificate": null,
+ "certificate_path": null,
+ "issuer": null,
+ "idp_initiated_sso": false,
+ "disable_admin_demote": false
},
- "members_can_create_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "github_oauth": {
+ "client_id": "12313412",
+ "client_secret": "kj123131132",
+ "organization_name": "Homestar Runners",
+ "organization_team": "homestarrunners/characters"
},
- "members_can_create_public_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "smtp": {
+ "enabled": true,
+ "address": "smtp.example.com",
+ "authentication": "plain",
+ "port": "1234",
+ "domain": "blah",
+ "username": "foo",
+ "user_name": "mr_foo",
+ "enable_starttls_auto": true,
+ "password": "bar",
+ "discard-to-noreply-address": true,
+ "support_address": "enterprise@github.com",
+ "support_address_type": "email",
+ "noreply_address": "noreply@github.com"
},
- "members_can_create_private_pages": {
- "type": "boolean",
- "examples": [
- true
- ]
+ "ntp": {
+ "primary_server": "0.pool.ntp.org",
+ "secondary_server": "1.pool.ntp.org"
},
- "members_can_fork_private_repositories": {
- "type": [
- "boolean",
- "null"
- ],
- "examples": [
- false
- ]
+ "timezone": null,
+ "snmp": {
+ "enabled": false,
+ "community": ""
},
- "web_commit_signoff_required": {
- "type": "boolean",
- "examples": [
- false
- ]
+ "syslog": {
+ "enabled": false,
+ "server": null,
+ "protocol_name": "udp"
},
- "updated_at": {
- "type": "string",
- "format": "date-time"
+ "assets": null,
+ "pages": {
+ "enabled": true
},
- "archived_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- }
+ "collectd": {
+ "enabled": false,
+ "server": null,
+ "port": 0,
+ "encryption": null,
+ "username": null,
+ "password": null
+ },
+ "mapping": {
+ "enabled": true,
+ "tileserver": null,
+ "basemap": "company.map-qsz2zrvs",
+ "token": null
+ },
+ "load_balancer": null
},
- "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.",
- "examples": [
- "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",
- "examples": [
- 37
- ]
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "examples": [
- 42
+ "run_list": [
+ "recipe[enterprise-configure]"
]
}
- },
- "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"
- }
- }
- }
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "put": {
+ "summary": "Set settings",
+ "description": "Applies settings on your instance. 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).\n\n**Notes:**\n\n- 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).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"",
+ "operationId": "enterprise-admin/set-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
}
}
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
},
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "string",
+ "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. 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": [
+ "settings"
+ ]
+ },
+ "examples": {
+ "204": {
+ "value": {
+ "settings": "{ \"enterprise\": { \"public_pages\": true }}"
}
}
}
}
- },
- "403": {
- "description": "Forbidden",
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/settings/authorized-keys": {
+ "get": {
+ "summary": "Get all authorized SSH keys",
+ "description": "",
+ "operationId": "enterprise-admin/get-all-authorized-ssh-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys"
+ },
+ "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": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
+ "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"
}
},
"x-github": {
"githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
},
- "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.",
+ "post": {
+ "summary": "Add 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/add-authorized-ssh-key",
"tags": [
- "teams"
+ "enterprise-admin"
],
- "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"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#add-an-authorized-ssh-key"
},
- "parameters": [
+ "servers": [
{
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
}
}
],
"responses": {
- "204": {
- "description": "Response"
- },
- "404": {
- "description": "Resource not found",
+ "201": {
+ "description": "Response",
"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"
+ "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"
+ }
+ ]
+ }
}
}
}
},
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": [
- "string",
- "null"
- ]
- },
- {
- "type": [
- "integer",
- "null"
- ]
- },
- {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
+ "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=="
}
}
}
@@ -559802,67 +554929,34 @@
},
"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/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.",
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "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": [
- "teams"
+ "enterprise-admin"
],
- "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"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key"
},
- "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
- }
- },
+ "servers": [
{
- "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
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
}
}
],
@@ -559874,428 +554968,63 @@
"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": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat"
- ]
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/followers"
- ]
- },
- "following_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
- ]
- },
- "gists_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
- ]
- },
- "starred_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- ]
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/subscriptions"
- ]
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/orgs"
- ]
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/repos"
- ]
- },
- "events_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
- ]
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/users/octocat/received_events"
- ]
- },
- "type": {
- "type": "string",
- "examples": [
- "User"
- ]
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "examples": [
- "\"2020-07-09T00:17:55Z\""
- ]
- },
- "user_view_type": {
- "type": "string",
- "examples": [
- "public"
- ]
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- ]
- },
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
- "type": "integer",
- "examples": [
- 0
- ]
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- ]
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
- ]
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
- ]
+ "key": {
+ "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"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "pretty-print": {
+ "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": 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
- }
+ "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"
}
]
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
+ }
+ },
+ "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=="
+ }
}
}
}
@@ -560303,114 +555032,294 @@
},
"x-github": {
"githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/start": {
"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.",
+ "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": [
- "teams"
+ "enterprise-admin"
],
- "operationId": "teams/create-discussion-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/enterprise-admin/management-console#create-a-github-license"
},
- "parameters": [
+ "servers": [
{
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
+ "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": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
"type": "object",
"properties": {
- "title": {
+ "license": {
"type": "string",
- "description": "The discussion post's title."
+ "description": "The content of your _.ghl_ license file."
},
- "body": {
+ "password": {
"type": "string",
- "description": "The discussion post's body text."
+ "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."
},
- "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
+ "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": [
- "title",
- "body"
+ "license"
]
},
"examples": {
"default": {
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "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": {
- "201": {
+ "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.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -560418,373 +555327,656 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
- }
+ "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"
}
}
}
@@ -560793,28 +555985,25 @@
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"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.",
+ },
+ "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/get-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -560825,58 +556014,189 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "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",
+ "null"
+ ],
+ "description": "The ID of a team to set as the parent team."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
"200": {
- "description": "Response",
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -560884,489 +556204,750 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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": 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
- }
+ "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": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 42
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Developers"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "push"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "parent": {
"anyOf": [
{
"type": "null"
},
{
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "type": [
- "string",
- "null"
- ]
- },
- "email": {
- "type": [
- "string",
- "null"
- ]
- },
- "login": {
- "type": "string",
- "examples": [
- "octocat"
- ]
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"examples": [
1
]
@@ -561374,378 +556955,762 @@
"node_id": {
"type": "string",
"examples": [
- "MDQ6VXNlcjE="
- ]
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/images/error/octocat_happy.gif"
- ]
- },
- "gravatar_id": {
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "41d064eb2195891e12d0413f63227ea7"
+ "MDQ6VGVhbTE="
]
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat"
+ "https://api.github.com/organizations/1/team/1"
]
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
"examples": [
- "https://github.com/octocat"
+ "https://api.github.com/organizations/1/team/1/members{/member}"
]
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/followers"
+ "Justice League"
]
},
- "following_url": {
- "type": "string",
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
"examples": [
- "https://api.github.com/users/octocat/following{/other_user}"
+ "A great team."
]
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/gists{/gist_id}"
+ "admin"
]
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "closed"
]
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/subscriptions"
+ "notifications_enabled"
]
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/orgs"
+ "https://github.com/orgs/rails/teams/core"
]
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/users/octocat/repos"
+ "https://api.github.com/organizations/1/team/1/repos"
]
},
- "events_url": {
+ "slug": {
"type": "string",
"examples": [
- "https://api.github.com/users/octocat/events{/privacy}"
+ "justice-league"
]
},
- "received_events_url": {
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
"type": "string",
- "format": "uri",
"examples": [
- "https://api.github.com/users/octocat/received_events"
+ "uid=example,ou=users,dc=github,dc=com"
]
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "examples": [
- "User"
+ "enum": [
+ "enterprise",
+ "organization"
]
},
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
"examples": [
- "\"2020-07-09T00:17:55Z\""
+ 37
]
},
- "user_view_type": {
- "type": "string",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
"examples": [
- "public"
+ 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"
]
}
]
},
- "body": {
- "description": "The main text of the discussion.",
- "type": "string",
- "examples": [
- "Please suggest improvements to our workflow in comments."
- ]
- },
- "body_html": {
- "type": "string",
- "examples": [
- "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.",
- "type": "string",
- "examples": [
- "0307116bbf7ced493b8d8a346c650b71"
- ]
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
"examples": [
- 0
+ 3
]
},
- "comments_url": {
- "type": "string",
- "format": "uri",
+ "repos_count": {
+ "type": "integer",
"examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ 10
]
},
"created_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "last_edited_at": {
- "type": [
- "string",
- "null"
- ],
- "format": "date-time"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1"
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- ]
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "type": "integer",
- "examples": [
- 42
- ]
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "type": "boolean",
- "examples": [
- true
- ]
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027"
- ]
- },
- "title": {
- "description": "The title of the discussion.",
- "type": "string",
- "examples": [
- "How can we improve our workflow?"
+ "2017-07-14T16:53:42Z"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-25T18:56:31Z"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "2017-08-17T12:37:15Z"
]
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDEyOk9yZ2FuaXphdGlvbjE="
+ ]
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github"
+ ]
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/repos"
+ ]
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/orgs/github/events"
+ ]
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/hooks"
+ ]
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/issues"
+ ]
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/members{/member}"
+ ]
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/orgs/github/public_members{/member}"
+ ]
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great organization"
+ ]
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "examples": [
+ "github"
+ ]
+ },
+ "company": {
+ "type": "string",
+ "examples": [
+ "GitHub"
+ ]
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/blog"
+ ]
+ },
+ "location": {
+ "type": "string",
+ "examples": [
+ "San Francisco"
+ ]
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "examples": [
+ "octocat@github.com"
+ ]
+ },
+ "twitter_username": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "github"
+ ]
+ },
+ "is_verified": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "public_repos": {
+ "type": "integer",
+ "examples": [
+ 2
+ ]
+ },
+ "public_gists": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "followers": {
+ "type": "integer",
+ "examples": [
+ 20
+ ]
+ },
+ "following": {
+ "type": "integer",
+ "examples": [
+ 0
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "examples": [
+ "2008-01-14T04:33:35Z"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "Organization"
+ ]
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "examples": [
+ 100
+ ]
+ },
+ "private_gists": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 81
+ ]
+ },
+ "disk_usage": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 10000
+ ]
+ },
+ "collaborators": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "examples": [
+ 8
+ ]
+ },
+ "billing_email": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "email",
+ "examples": [
+ "org@example.com"
+ ]
+ },
+ "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",
+ "null"
+ ]
+ },
+ "members_can_create_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "two_factor_requirement_enabled": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ true
+ ]
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "examples": [
+ "all"
+ ]
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "members_can_fork_private_repositories": {
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "examples": [
+ false
+ ]
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "examples": [
+ false
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time"
}
},
"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.",
+ "examples": [
+ "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",
+ "examples": [
+ 37
+ ]
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "examples": [
+ 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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "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": {
@@ -561754,20 +557719,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": [
{
@@ -561778,20 +557743,112 @@
"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",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -561800,22 +557857,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": [
{
@@ -561827,15 +557884,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.",
@@ -561877,8 +557925,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": {
@@ -562057,16 +558105,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -562080,7 +558128,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -562090,45 +558138,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -562188,10 +558257,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -562221,19 +558293,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,
@@ -562266,20 +558341,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": [
{
@@ -562290,15 +558365,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -562308,19 +558374,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."
}
}
}
@@ -562333,8 +558410,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": {
@@ -562513,16 +558590,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -562536,7 +558613,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -562546,45 +558623,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -562644,10 +558742,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -562675,19 +558776,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,
@@ -562712,22 +558816,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": [
{
@@ -562747,15 +558851,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -562764,8 +558859,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": {
@@ -562944,16 +559039,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -562967,7 +559062,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -562977,45 +559072,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -563075,10 +559191,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -563106,19 +559225,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,
@@ -563142,20 +559264,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": [
{
@@ -563175,37 +559297,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"
}
}
}
@@ -563218,8 +559332,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": {
@@ -563398,16 +559512,16 @@
]
},
"body": {
- "description": "The main text of the comment.",
+ "description": "The main text of the discussion.",
"type": "string",
"examples": [
- "I agree with this suggestion."
+ "Please suggest improvements to our workflow in comments."
]
},
"body_html": {
"type": "string",
"examples": [
- "Do you like apples?
"
+ "Hi! This is an area for us to collaborate as a team
"
]
},
"body_version": {
@@ -563421,7 +559535,7 @@
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"last_edited_at": {
@@ -563431,45 +559545,66 @@
],
"format": "date-time"
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1"
- ]
- },
"html_url": {
"type": "string",
"format": "uri",
"examples": [
- "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "https://github.com/orgs/github/teams/justice-league/discussions/1"
]
},
"node_id": {
"type": "string",
"examples": [
- "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
]
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"type": "integer",
"examples": [
42
]
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "type": "boolean",
+ "examples": [
+ true
+ ]
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/2343027"
+ ]
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "type": "string",
+ "examples": [
+ "How can we improve our workflow?"
+ ]
+ },
"updated_at": {
"type": "string",
"format": "date-time",
"examples": [
- "2018-01-15T23:53:58Z"
+ "2018-01-25T18:56:31Z"
]
},
"url": {
"type": "string",
"format": "uri",
"examples": [
- "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "https://api.github.com/organizations/1/team/2343027/discussions/1"
]
},
"reactions": {
@@ -563529,10 +559664,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -563560,19 +559698,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,
@@ -563596,20 +559737,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": [
{
@@ -563629,15 +559770,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -563651,7 +559783,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
index 93319e5a5..ebab52493 100644
--- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
+++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
@@ -4664,7 +4664,7 @@ paths:
application/json:
schema: *22
application/scim+json:
- schema: &534
+ schema: &531
title: Scim Error
description: Scim Error
type: object
@@ -12723,7 +12723,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &369
+ instances_url: &366
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -12759,7 +12759,7 @@ paths:
format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissed_reason: &370
+ dismissed_reason: &367
type:
- string
- 'null'
@@ -12770,14 +12770,14 @@ paths:
- won't fix
- used in tests
-
- dismissed_comment: &371
+ dismissed_comment: &368
type:
- string
- 'null'
description: The dismissal comment associated with the dismissal
of the alert.
maxLength: 280
- rule: &372
+ rule: &369
type: object
properties:
id:
@@ -12822,7 +12822,7 @@ paths:
description: A set of tags applicable for the rule.
items:
type: string
- tool: &373
+ tool: &370
type: object
properties:
name: *88
@@ -12833,26 +12833,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *89
- most_recent_instance: &374
+ most_recent_instance: &371
type: object
properties:
- ref: &367
+ ref: &364
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &379
+ analysis_key: &376
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: &380
+ environment: &377
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: &381
+ category: &378
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -12866,7 +12866,7 @@ paths:
properties:
text:
type: string
- location: &382
+ location: &379
type: object
description: Describe a region within a file for the alert.
properties:
@@ -12887,7 +12887,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: &383
+ items: &380
type:
- string
- 'null'
@@ -13720,7 +13720,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
- - &404
+ - &401
name: has
in: query
description: |-
@@ -13845,7 +13845,7 @@ paths:
- development
- runtime
-
- security_advisory: &405
+ security_advisory: &402
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -14080,7 +14080,7 @@ paths:
dismissal.
maxLength: 280
fixed_at: *100
- auto_dismissed_at: &406
+ auto_dismissed_at: &403
type:
- string
- 'null'
@@ -14088,7 +14088,7 @@ paths:
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissal_request: &407
+ dismissal_request: &404
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -14562,14 +14562,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &525
+ state: &522
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: &526
+ resolution: &523
type:
- string
- 'null'
@@ -15456,7 +15456,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &561
+ type: &558
title: Issue Type
description: The type of issue.
type:
@@ -15567,7 +15567,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &558
+ sub_issues_summary: &555
title: Sub-issues Summary
type: object
properties:
@@ -15588,7 +15588,7 @@ paths:
- string
- 'null'
format: uri
- issue_dependencies_summary: &559
+ issue_dependencies_summary: &556
title: Issue Dependencies Summary
type: object
properties:
@@ -15607,7 +15607,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &560
+ items: &557
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -15774,7 +15774,7 @@ paths:
action:
type: string
issue: *105
- comment: &448
+ comment: &445
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -16475,7 +16475,7 @@ paths:
- review_comment
- self
author_association: *106
- auto_merge: &396
+ auto_merge: &393
title: Auto merge
description: The status of auto merging a pull request.
type:
@@ -16958,7 +16958,7 @@ paths:
type: string
release:
allOf:
- - &503
+ - &500
title: Release
description: A release.
type: object
@@ -17040,7 +17040,7 @@ paths:
author: *17
assets:
type: array
- items: &504
+ items: &501
title: Release Asset
description: Data related to a release.
type: object
@@ -17632,7 +17632,7 @@ paths:
url:
type: string
format: uri
- user: &576
+ user: &571
title: Public User
description: Public User
type: object
@@ -22321,14 +22321,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:
- - &290
+ - &287
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &291
+ - &288
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -22400,7 +22400,7 @@ paths:
'404': *24
'403': *41
'304': *40
- '301': &302
+ '301': &299
description: Moved permanently
content:
application/json:
@@ -22422,7 +22422,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:
- - &477
+ - &474
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -22430,7 +22430,7 @@ paths:
schema:
type: boolean
default: false
- - &478
+ - &475
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -22440,7 +22440,7 @@ paths:
type: boolean
default: false
- *113
- - &479
+ - &476
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:
@@ -22946,7 +22946,7 @@ paths:
- url
- subscription_url
examples:
- default: &480
+ default: &477
value:
- id: '1'
repository:
@@ -23499,7 +23499,7 @@ paths:
type: array
items: *68
examples:
- default: &585
+ default: &580
value:
- login: github
id: 1
@@ -24468,7 +24468,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &307
+ items: &304
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -24722,7 +24722,7 @@ paths:
type: array
items: *82
examples:
- default: &582
+ default: &577
value:
total_count: 1
repositories:
@@ -26528,7 +26528,7 @@ paths:
description: Response
content:
application/json:
- schema: &329
+ schema: &326
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -26563,7 +26563,7 @@ paths:
- key_id
- key
examples:
- default: &330
+ default: &327
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -26976,7 +26976,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-organization-variables
parameters:
- *134
- - &314
+ - &311
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)."
@@ -27630,7 +27630,7 @@ paths:
be returned.
in: query
required: false
- schema: &368
+ schema: &365
type: string
description: Severity of a code scanning alert.
enum:
@@ -28177,7 +28177,7 @@ paths:
description: Response
content:
application/json:
- schema: &410
+ schema: &407
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -28196,7 +28196,7 @@ paths:
- key_id
- key
examples:
- default: &411
+ default: &408
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -28795,7 +28795,7 @@ paths:
description: Response
content:
application/json:
- schema: &285
+ schema: &282
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -28885,7 +28885,7 @@ paths:
member_name: Octo Lisa
member_email: octo_lisa@github.com
examples:
- default: &286
+ default: &283
value:
group_id: '123'
group_name: Octocat admins
@@ -28940,7 +28940,7 @@ paths:
description: Response
content:
application/json:
- schema: &283
+ schema: &280
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -28980,7 +28980,7 @@ paths:
group_name: group-azuread-test2
updated_at: 2021-06-03 22:27:15:000 -700
examples:
- default: &284
+ default: &281
value:
groups:
- group_id: '123'
@@ -29631,7 +29631,7 @@ paths:
application/json:
schema: *37
examples:
- default: &445
+ default: &442
value:
id: 1
account:
@@ -32358,7 +32358,7 @@ paths:
- nuget
- container
- *134
- - &586
+ - &581
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -32399,7 +32399,7 @@ paths:
default: *215
'403': *41
'401': *39
- '400': &588
+ '400': &583
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -34908,7 +34908,7 @@ paths:
description: Response
content:
application/json:
- schema: &301
+ schema: &298
title: Full Repository
description: Full Repository
type: object
@@ -35487,7 +35487,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &303
+ default: &300
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -36059,7 +36059,7 @@ paths:
- *134
- *4
- *5
- - &511
+ - &508
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -36338,7 +36338,7 @@ paths:
- object
rules:
type: array
- items: &512
+ items: &509
title: Repository Rule
type: object
description: A repository rule.
@@ -37084,7 +37084,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *134
- - &513
+ - &510
name: ref
description: The name of the ref. Cannot contain wildcard characters. When
specified, only rule evaluations triggered for this ref will be returned.
@@ -37097,7 +37097,7 @@ paths:
in: query
schema:
type: string
- - &514
+ - &511
name: time_period
description: |-
The time period to filter by.
@@ -37113,14 +37113,14 @@ paths:
- week
- month
default: day
- - &515
+ - &512
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
- - &516
+ - &513
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -37140,7 +37140,7 @@ paths:
description: Response
content:
application/json:
- schema: &517
+ schema: &514
title: Rule Suites
description: Response
type: array
@@ -37195,7 +37195,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &518
+ default: &515
value:
- id: 21
actor_id: 12
@@ -37239,7 +37239,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *134
- - &519
+ - &516
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -37255,7 +37255,7 @@ paths:
description: Response
content:
application/json:
- schema: &520
+ schema: &517
title: Rule Suite
description: Response
type: object
@@ -37360,7 +37360,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &521
+ default: &518
value:
id: 21
actor_id: 12
@@ -37578,7 +37578,7 @@ paths:
- *9
- *5
- *4
- - &523
+ - &520
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
@@ -37588,7 +37588,7 @@ paths:
required: false
schema:
type: string
- - &524
+ - &521
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
@@ -37760,7 +37760,7 @@ paths:
application/json:
schema:
type: array
- items: &292
+ items: &289
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -38616,15 +38616,6 @@ paths:
type: string
examples:
- 0307116bbf7ced493b8d8a346c650b71
- comments_count:
- type: integer
- examples:
- - 0
- comments_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -38687,8 +38678,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -38701,7 +38690,7 @@ paths:
- updated_at
- url
examples:
- default: &566
+ default: &563
value:
- author:
login: octocat
@@ -38726,8 +38715,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
@@ -38837,8 +38824,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
@@ -38949,7 +38934,7 @@ paths:
application/json:
schema: *277
examples:
- default: &567
+ default: &564
value:
author:
login: octocat
@@ -38974,8 +38959,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
@@ -39030,418 +39013,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:
- - *134
- - *211
- - *279
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &280
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- anyOf:
- - type: 'null'
- - *17
- body:
- description: The main text of the comment.
- type: string
- examples:
- - I agree with this suggestion.
- body_html:
- type: string
- examples:
- - "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.
- type: string
- examples:
- - 0307116bbf7ced493b8d8a346c650b71
- created_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- last_edited_at:
- type:
- - string
- - 'null'
- format: date-time
- discussion_url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- examples:
- - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- examples:
- - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- type: integer
- examples:
- - 42
- updated_at:
- type: string
- format: date-time
- examples:
- - '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- examples:
- - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *107
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &568
- 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:
- - *134
- - *211
- - *279
- 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: *280
- examples:
- default: &281
- 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:
- - *134
- - *211
- - *279
- - &282
- 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: *280
- examples:
- default: *281
- 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:
- - *134
- - *211
- - *279
- - *282
- 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: *280
- examples:
- default: &569
- 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:
- - *134
- - *211
- - *279
- - *282
- 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
@@ -39463,9 +39034,9 @@ paths:
description: Response
content:
application/json:
- schema: *283
+ schema: *280
examples:
- default: *284
+ default: *281
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -39509,9 +39080,9 @@ paths:
description: Response
content:
application/json:
- schema: *285
+ schema: *282
examples:
- default: *286
+ default: *283
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -39616,7 +39187,7 @@ paths:
description: Response
content:
application/json:
- schema: &287
+ schema: &284
title: Team Membership
description: Team Membership
type: object
@@ -39644,7 +39215,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &570
+ response-if-user-is-a-team-maintainer: &565
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39707,9 +39278,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *284
examples:
- response-if-users-membership-with-team-is-now-pending: &571
+ response-if-users-membership-with-team-is-now-pending: &566
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39782,7 +39353,7 @@ paths:
application/json:
schema:
type: array
- items: &288
+ items: &285
title: Team Project
description: A team's access to a project.
type: object
@@ -39851,7 +39422,7 @@ paths:
- updated_at
- permissions
examples:
- default: &572
+ default: &567
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39916,7 +39487,7 @@ paths:
parameters:
- *134
- *211
- - &289
+ - &286
name: project_id
description: The unique identifier of the project.
in: path
@@ -39928,9 +39499,9 @@ paths:
description: Response
content:
application/json:
- schema: *288
+ schema: *285
examples:
- default: &573
+ default: &568
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39994,7 +39565,7 @@ paths:
parameters:
- *134
- *211
- - *289
+ - *286
requestBody:
required: false
content:
@@ -40063,7 +39634,7 @@ paths:
parameters:
- *134
- *211
- - *289
+ - *286
responses:
'204':
description: Response
@@ -40134,14 +39705,14 @@ paths:
parameters:
- *134
- *211
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &574
+ schema: &569
title: Team Repository
description: A team's access to a repository.
type: object
@@ -40784,8 +40355,8 @@ paths:
parameters:
- *134
- *211
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -40832,8 +40403,8 @@ paths:
parameters:
- *134
- *211
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -40868,9 +40439,9 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
- response-if-child-teams-exist: &575
+ response-if-child-teams-exist: &570
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -40997,7 +40568,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card
parameters:
- - &293
+ - &290
name: card_id
description: The unique identifier of the card.
in: path
@@ -41009,7 +40580,7 @@ paths:
description: Response
content:
application/json:
- schema: &294
+ schema: &291
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -41084,7 +40655,7 @@ paths:
- created_at
- updated_at
examples:
- default: &295
+ default: &292
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -41140,7 +40711,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:
- - *293
+ - *290
requestBody:
required: false
content:
@@ -41170,9 +40741,9 @@ paths:
description: Response
content:
application/json:
- schema: *294
+ schema: *291
examples:
- default: *295
+ default: *292
'304': *40
'403': *41
'401': *39
@@ -41199,7 +40770,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card
parameters:
- - *293
+ - *290
responses:
'204':
description: Response
@@ -41243,7 +40814,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card
parameters:
- - *293
+ - *290
requestBody:
required: true
content:
@@ -41356,7 +40927,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column
parameters:
- - &296
+ - &293
name: column_id
description: The unique identifier of the column.
in: path
@@ -41368,7 +40939,7 @@ paths:
description: Response
content:
application/json:
- schema: &297
+ schema: &294
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -41422,7 +40993,7 @@ paths:
- created_at
- updated_at
examples:
- default: &298
+ default: &295
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -41457,7 +41028,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:
- - *296
+ - *293
requestBody:
required: true
content:
@@ -41482,9 +41053,9 @@ paths:
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
- default: *298
+ default: *295
'304': *40
'403': *41
'401': *39
@@ -41509,7 +41080,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column
parameters:
- - *296
+ - *293
responses:
'204':
description: Response
@@ -41538,7 +41109,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#list-project-cards
parameters:
- - *296
+ - *293
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -41559,7 +41130,7 @@ paths:
application/json:
schema:
type: array
- items: *294
+ items: *291
examples:
default:
value:
@@ -41618,7 +41189,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#create-a-project-card
parameters:
- - *296
+ - *293
requestBody:
required: true
content:
@@ -41662,9 +41233,9 @@ paths:
description: Response
content:
application/json:
- schema: *294
+ schema: *291
examples:
- default: *295
+ default: *292
'304': *40
'403': *41
'401': *39
@@ -41720,7 +41291,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#move-a-project-column
parameters:
- - *296
+ - *293
requestBody:
required: true
content:
@@ -41780,7 +41351,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#get-a-project
parameters:
- - *289
+ - *286
responses:
'200':
description: Response
@@ -41788,7 +41359,7 @@ paths:
application/json:
schema: *232
examples:
- default: &299
+ default: &296
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -41842,7 +41413,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#update-a-project
parameters:
- - *289
+ - *286
requestBody:
required: false
content:
@@ -41893,7 +41464,7 @@ paths:
application/json:
schema: *232
examples:
- default: *299
+ default: *296
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -41933,7 +41504,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#delete-a-project
parameters:
- - *289
+ - *286
responses:
'204':
description: Delete Success
@@ -41976,7 +41547,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#list-project-collaborators
parameters:
- - *289
+ - *286
- 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
@@ -42033,7 +41604,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#add-project-collaborator
parameters:
- - *289
+ - *286
- *8
requestBody:
required: false
@@ -42088,7 +41659,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:
- - *289
+ - *286
- *8
responses:
'204':
@@ -42120,7 +41691,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:
- - *289
+ - *286
- *8
responses:
'200':
@@ -42191,7 +41762,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#list-project-columns
parameters:
- - *289
+ - *286
- *4
- *5
responses:
@@ -42201,7 +41772,7 @@ paths:
application/json:
schema:
type: array
- items: *297
+ items: *294
examples:
default:
value:
@@ -42239,7 +41810,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#create-a-project-column
parameters:
- - *289
+ - *286
requestBody:
required: true
content:
@@ -42263,7 +41834,7 @@ paths:
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
default:
value:
@@ -42328,7 +41899,7 @@ paths:
resources:
type: object
properties:
- core: &300
+ core: &297
title: Rate Limit
type: object
properties:
@@ -42345,20 +41916,20 @@ paths:
- remaining
- reset
- used
- graphql: *300
- search: *300
- code_search: *300
- source_import: *300
- integration_manifest: *300
- code_scanning_upload: *300
- actions_runner_registration: *300
- scim: *300
- dependency_sbom: *300
- code_scanning_autofix: *300
+ graphql: *297
+ search: *297
+ code_search: *297
+ source_import: *297
+ integration_manifest: *297
+ code_scanning_upload: *297
+ actions_runner_registration: *297
+ scim: *297
+ dependency_sbom: *297
+ code_scanning_autofix: *297
required:
- core
- search
- rate: *300
+ rate: *297
required:
- rate
- resources
@@ -42463,14 +42034,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *301
+ schema: *298
examples:
default-response:
summary: Default response
@@ -42969,7 +42540,7 @@ paths:
status: disabled
'403': *41
'404': *24
- '301': *302
+ '301': *299
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42987,8 +42558,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -43205,10 +42776,10 @@ paths:
description: Response
content:
application/json:
- schema: *301
+ schema: *298
examples:
- default: *303
- '307': &304
+ default: *300
+ '307': &301
description: Temporary Redirect
content:
application/json:
@@ -43253,8 +42824,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -43276,7 +42847,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': *304
+ '307': *301
'404': *24
'409': *139
x-github:
@@ -43300,11 +42871,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
- - &321
+ - &318
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -43327,7 +42898,7 @@ paths:
type: integer
artifacts:
type: array
- items: &305
+ items: &302
title: Artifact
description: An artifact
type: object
@@ -43413,7 +42984,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &322
+ default: &319
value:
total_count: 2
artifacts:
@@ -43472,9 +43043,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact
parameters:
- - *290
- - *291
- - &306
+ - *287
+ - *288
+ - &303
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -43486,7 +43057,7 @@ paths:
description: Response
content:
application/json:
- schema: *305
+ schema: *302
examples:
default:
value:
@@ -43523,9 +43094,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact
parameters:
- - *290
- - *291
- - *306
+ - *287
+ - *288
+ - *303
responses:
'204':
description: Response
@@ -43549,9 +43120,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact
parameters:
- - *290
- - *291
- - *306
+ - *287
+ - *288
+ - *303
- name: archive_format
in: path
required: true
@@ -43588,14 +43159,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *307
+ schema: *304
examples:
default:
value:
@@ -43621,14 +43192,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: &308
+ schema: &305
title: Actions cache usage policy for repository
description: GitHub Actions cache usage policy for repository.
type: object
@@ -43641,7 +43212,7 @@ paths:
required:
- repo_cache_size_limit_in_gb
examples:
- default: &309
+ default: &306
value:
repo_cache_size_limit_in_gb: 14
x-github:
@@ -43662,8 +43233,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -43671,9 +43242,9 @@ paths:
required: true
content:
application/json:
- schema: *308
+ schema: *305
examples:
- selected_actions: *309
+ selected_actions: *306
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -43693,11 +43264,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:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
- - &310
+ - &307
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
@@ -43731,7 +43302,7 @@ paths:
description: Response
content:
application/json:
- schema: &311
+ schema: &308
title: Repository actions caches
description: Repository actions caches
type: object
@@ -43781,7 +43352,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &312
+ default: &309
value:
total_count: 1
actions_caches:
@@ -43813,23 +43384,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:
- - *290
- - *291
+ - *287
+ - *288
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *310
+ - *307
responses:
'200':
description: Response
content:
application/json:
- schema: *311
+ schema: *308
examples:
- default: *312
+ default: *309
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -43849,8 +43420,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:
- - *290
- - *291
+ - *287
+ - *288
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -43881,9 +43452,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:
- - *290
- - *291
- - &313
+ - *287
+ - *288
+ - &310
name: job_id
description: The unique identifier of the job.
in: path
@@ -43895,7 +43466,7 @@ paths:
description: Response
content:
application/json:
- schema: &325
+ schema: &322
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -44242,9 +43813,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:
- - *290
- - *291
- - *313
+ - *287
+ - *288
+ - *310
responses:
'302':
description: Response
@@ -44272,9 +43843,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:
- - *290
- - *291
- - *313
+ - *287
+ - *288
+ - *310
requestBody:
required: false
content:
@@ -44320,8 +43891,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Status response
@@ -44371,8 +43942,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -44435,8 +44006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -44454,7 +44025,7 @@ paths:
type: integer
secrets:
type: array
- items: &327
+ items: &324
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -44475,7 +44046,7 @@ paths:
- created_at
- updated_at
examples:
- default: &328
+ default: &325
value:
total_count: 2
secrets:
@@ -44508,9 +44079,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-organization-variables
parameters:
- - *290
- - *291
- - *314
+ - *287
+ - *288
+ - *311
- *5
responses:
'200':
@@ -44527,7 +44098,7 @@ paths:
type: integer
variables:
type: array
- items: &331
+ items: &328
title: Actions Variable
type: object
properties:
@@ -44561,7 +44132,7 @@ paths:
- created_at
- updated_at
examples:
- default: &332
+ default: &329
value:
total_count: 2
variables:
@@ -44594,8 +44165,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -44604,7 +44175,7 @@ paths:
schema:
type: object
properties:
- enabled: &315
+ enabled: &312
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *67
@@ -44637,8 +44208,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -44649,7 +44220,7 @@ paths:
schema:
type: object
properties:
- enabled: *315
+ enabled: *312
allowed_actions: *67
required:
- enabled
@@ -44680,14 +44251,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: &316
+ schema: &313
type: object
properties:
access_level:
@@ -44705,7 +44276,7 @@ paths:
required:
- access_level
examples:
- default: &317
+ default: &314
value:
access_level: organization
x-github:
@@ -44730,15 +44301,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
application/json:
- schema: *316
+ schema: *313
examples:
- default: *317
+ default: *314
responses:
'204':
description: Response
@@ -44762,8 +44333,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -44794,8 +44365,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -44827,8 +44398,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -44857,8 +44428,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Success response
@@ -44898,8 +44469,8 @@ paths:
in: query
schema:
type: string
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -44943,8 +44514,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -44976,8 +44547,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -45051,8 +44622,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'201':
description: Response
@@ -45088,8 +44659,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'201':
description: Response
@@ -45119,8 +44690,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
responses:
'200':
@@ -45150,8 +44721,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
responses:
'204':
@@ -45178,8 +44749,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
responses:
'200': *85
@@ -45204,8 +44775,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
requestBody:
required: true
@@ -45254,8 +44825,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
requestBody:
required: true
@@ -45305,8 +44876,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
responses:
'200': *159
@@ -45336,8 +44907,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:
- - *290
- - *291
+ - *287
+ - *288
- *79
- *160
responses:
@@ -45367,9 +44938,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:
- - *290
- - *291
- - &335
+ - *287
+ - *288
+ - &332
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.
@@ -45377,7 +44948,7 @@ paths:
required: false
schema:
type: string
- - &336
+ - &333
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -45385,7 +44956,7 @@ paths:
required: false
schema:
type: string
- - &337
+ - &334
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -45394,7 +44965,7 @@ paths:
required: false
schema:
type: string
- - &338
+ - &335
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
@@ -45421,7 +44992,7 @@ paths:
- pending
- *4
- *5
- - &339
+ - &336
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)."
@@ -45430,7 +45001,7 @@ paths:
schema:
type: string
format: date-time
- - &318
+ - &315
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -45439,13 +45010,13 @@ paths:
schema:
type: boolean
default: false
- - &340
+ - &337
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &341
+ - &338
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -45468,7 +45039,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &319
+ items: &316
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -45585,7 +45156,7 @@ paths:
type:
- array
- 'null'
- items: &359
+ items: &356
title: Pull Request Minimal
type: object
properties:
@@ -45712,7 +45283,7 @@ paths:
head_commit:
anyOf:
- type: 'null'
- - &363
+ - &360
title: Simple Commit
description: A commit.
type: object
@@ -45827,7 +45398,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &342
+ default: &339
value:
total_count: 1
workflow_runs:
@@ -46063,24 +45634,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *290
- - *291
- - &320
+ - *287
+ - *288
+ - &317
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *318
+ - *315
responses:
'200':
description: Response
content:
application/json:
- schema: *319
+ schema: *316
examples:
- default: &323
+ default: &320
value:
id: 30433642
name: Build
@@ -46321,9 +45892,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'204':
description: Response
@@ -46346,9 +45917,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'200':
description: Response
@@ -46478,12 +46049,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
- *4
- *5
- - *321
+ - *318
responses:
'200':
description: Response
@@ -46499,9 +46070,9 @@ paths:
type: integer
artifacts:
type: array
- items: *305
+ items: *302
examples:
- default: *322
+ default: *319
headers:
Link: *6
x-github:
@@ -46525,25 +46096,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:
- - *290
- - *291
- - *320
- - &324
+ - *287
+ - *288
+ - *317
+ - &321
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *318
+ - *315
responses:
'200':
description: Response
content:
application/json:
- schema: *319
+ schema: *316
examples:
- default: *323
+ default: *320
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46566,10 +46137,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:
- - *290
- - *291
- - *320
- - *324
+ - *287
+ - *288
+ - *317
+ - *321
- *4
- *5
responses:
@@ -46587,9 +46158,9 @@ paths:
type: integer
jobs:
type: array
- items: *325
+ items: *322
examples:
- default: &326
+ default: &323
value:
total_count: 1
jobs:
@@ -46702,10 +46273,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:
- - *290
- - *291
- - *320
- - *324
+ - *287
+ - *288
+ - *317
+ - *321
responses:
'302':
description: Response
@@ -46733,9 +46304,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'202':
description: Response
@@ -46768,9 +46339,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
requestBody:
required: true
content:
@@ -46837,9 +46408,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'202':
description: Response
@@ -46872,9 +46443,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
- 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
@@ -46904,9 +46475,9 @@ paths:
type: integer
jobs:
type: array
- items: *325
+ items: *322
examples:
- default: *326
+ default: *323
headers:
Link: *6
x-github:
@@ -46931,9 +46502,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'302':
description: Response
@@ -46960,9 +46531,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'204':
description: Response
@@ -46989,9 +46560,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
responses:
'200':
description: Response
@@ -47060,7 +46631,7 @@ paths:
items:
type: object
properties:
- type: &419
+ type: &416
type: string
description: The type of reviewer.
enum:
@@ -47071,7 +46642,7 @@ paths:
reviewer:
anyOf:
- *17
- - *292
+ - *289
required:
- environment
- wait_timer
@@ -47146,9 +46717,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
requestBody:
required: true
content:
@@ -47198,7 +46769,7 @@ paths:
application/json:
schema:
type: array
- items: &414
+ items: &411
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -47310,7 +46881,7 @@ paths:
- created_at
- updated_at
examples:
- default: &415
+ default: &412
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -47366,9 +46937,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
requestBody:
required: false
content:
@@ -47413,9 +46984,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:
- - *290
- - *291
- - *320
+ - *287
+ - *288
+ - *317
requestBody:
required: false
content:
@@ -47463,8 +47034,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-secrets
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -47482,9 +47053,9 @@ paths:
type: integer
secrets:
type: array
- items: *327
+ items: *324
examples:
- default: *328
+ default: *325
headers:
Link: *6
x-github:
@@ -47509,16 +47080,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- default: *330
+ default: *327
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -47540,17 +47111,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-secret
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *327
+ schema: *324
examples:
- default: &432
+ default: &429
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -47576,8 +47147,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:
- - *290
- - *291
+ - *287
+ - *288
- *162
requestBody:
required: true
@@ -47635,8 +47206,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *162
responses:
'204':
@@ -47662,9 +47233,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-variables
parameters:
- - *290
- - *291
- - *314
+ - *287
+ - *288
+ - *311
- *5
responses:
'200':
@@ -47681,9 +47252,9 @@ paths:
type: integer
variables:
type: array
- items: *331
+ items: *328
examples:
- default: *332
+ default: *329
headers:
Link: *6
x-github:
@@ -47706,8 +47277,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-a-repository-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -47759,17 +47330,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-a-repository-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *165
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: &433
+ default: &430
value:
name: USERNAME
value: octocat
@@ -47795,8 +47366,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-a-repository-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *165
requestBody:
required: true
@@ -47839,8 +47410,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-a-repository-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *165
responses:
'204':
@@ -47866,8 +47437,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#list-repository-workflows
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -47885,7 +47456,7 @@ paths:
type: integer
workflows:
type: array
- items: &333
+ items: &330
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -48003,9 +47574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#get-a-workflow
parameters:
- - *290
- - *291
- - &334
+ - *287
+ - *288
+ - &331
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -48020,7 +47591,7 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
default:
value:
@@ -48053,9 +47624,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#disable-a-workflow
parameters:
- - *290
- - *291
- - *334
+ - *287
+ - *288
+ - *331
responses:
'204':
description: Response
@@ -48080,9 +47651,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *290
- - *291
- - *334
+ - *287
+ - *288
+ - *331
responses:
'204':
description: Response
@@ -48133,9 +47704,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#enable-a-workflow
parameters:
- - *290
- - *291
- - *334
+ - *287
+ - *288
+ - *331
responses:
'204':
description: Response
@@ -48162,19 +47733,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:
- - *290
- - *291
+ - *287
+ - *288
+ - *331
+ - *332
+ - *333
- *334
- *335
+ - *4
+ - *5
- *336
+ - *315
- *337
- *338
- - *4
- - *5
- - *339
- - *318
- - *340
- - *341
responses:
'200':
description: Response
@@ -48190,9 +47761,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *319
+ items: *316
examples:
- default: *342
+ default: *339
headers:
Link: *6
x-github:
@@ -48215,8 +47786,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-activities
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *9
- *4
- *86
@@ -48384,8 +47955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#list-assignees
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -48422,8 +47993,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:
- - *290
- - *291
+ - *287
+ - *288
- name: assignee
in: path
required: true
@@ -48457,8 +48028,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -48466,7 +48037,7 @@ paths:
application/json:
schema:
type: array
- items: &343
+ items: &340
title: Autolink reference
description: An autolink reference.
type: object
@@ -48525,8 +48096,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -48565,9 +48136,9 @@ paths:
description: response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: &344
+ default: &341
value:
id: 1
key_prefix: TICKET-
@@ -48598,9 +48169,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:
- - *290
- - *291
- - &345
+ - *287
+ - *288
+ - &342
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -48612,9 +48183,9 @@ paths:
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: *344
+ default: *341
'404': *24
x-github:
githubCloudOnly: false
@@ -48634,9 +48205,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:
- - *290
- - *291
- - *345
+ - *287
+ - *288
+ - *342
responses:
'204':
description: Response
@@ -48660,8 +48231,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response if Dependabot is enabled
@@ -48710,8 +48281,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#list-branches
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -48749,7 +48320,7 @@ paths:
- url
protected:
type: boolean
- protection: &347
+ protection: &344
title: Branch Protection
description: Branch Protection
type: object
@@ -48792,7 +48363,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &350
+ enforce_admins: &347
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -48809,7 +48380,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &352
+ required_pull_request_reviews: &349
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -48831,7 +48402,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *292
+ items: *289
apps:
description: The list of apps with review dismissal
access.
@@ -48863,7 +48434,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *292
+ items: *289
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -48893,7 +48464,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &349
+ restrictions: &346
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -48956,7 +48527,7 @@ paths:
type: string
teams:
type: array
- items: *292
+ items: *289
apps:
type: array
items:
@@ -49186,9 +48757,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#get-a-branch
parameters:
- - *290
- - *291
- - &348
+ - *287
+ - *288
+ - &345
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).
@@ -49202,14 +48773,14 @@ paths:
description: Response
content:
application/json:
- schema: &358
+ schema: &355
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &392
+ commit: &389
title: Commit
description: Commit
type: object
@@ -49248,7 +48819,7 @@ paths:
author:
anyOf:
- type: 'null'
- - &346
+ - &343
title: Git User
description: Metaproperties for Git author/committer
information.
@@ -49270,7 +48841,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *346
+ - *343
message:
type: string
examples:
@@ -49294,7 +48865,7 @@ paths:
required:
- sha
- url
- verification: &439
+ verification: &436
title: Verification
type: object
properties:
@@ -49369,7 +48940,7 @@ paths:
type: integer
files:
type: array
- items: &401
+ items: &398
title: Diff Entry
description: Diff Entry
type: object
@@ -49465,7 +49036,7 @@ paths:
- self
protected:
type: boolean
- protection: *347
+ protection: *344
protection_url:
type: string
format: uri
@@ -49571,7 +49142,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *302
+ '301': *299
'404': *24
x-github:
githubCloudOnly: false
@@ -49593,15 +49164,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *347
+ schema: *344
examples:
default:
value:
@@ -49795,9 +49366,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -50057,7 +49628,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &355
+ required_status_checks: &352
title: Status Check Policy
description: Status Check Policy
type: object
@@ -50138,7 +49709,7 @@ paths:
items: *17
teams:
type: array
- items: *292
+ items: *289
apps:
type: array
items: *23
@@ -50156,7 +49727,7 @@ paths:
items: *17
teams:
type: array
- items: *292
+ items: *289
apps:
type: array
items: *23
@@ -50216,7 +49787,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *349
+ restrictions: *346
required_conversation_resolution:
type: object
properties:
@@ -50328,9 +49899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -50355,17 +49926,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *350
+ schema: *347
examples:
- default: &351
+ default: &348
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -50387,17 +49958,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *350
+ schema: *347
examples:
- default: *351
+ default: *348
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50416,9 +49987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -50443,17 +50014,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *352
+ schema: *349
examples:
- default: &353
+ default: &350
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -50549,9 +50120,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -50649,9 +50220,9 @@ paths:
description: Response
content:
application/json:
- schema: *352
+ schema: *349
examples:
- default: *353
+ default: *350
'422': *33
x-github:
githubCloudOnly: false
@@ -50672,9 +50243,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -50701,17 +50272,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *350
+ schema: *347
examples:
- default: &354
+ default: &351
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -50734,17 +50305,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *350
+ schema: *347
examples:
- default: *354
+ default: *351
'404': *24
x-github:
githubCloudOnly: false
@@ -50764,9 +50335,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -50791,17 +50362,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: &356
+ default: &353
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -50827,9 +50398,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -50881,9 +50452,9 @@ paths:
description: Response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: *356
+ default: *353
'404': *24
'422': *33
x-github:
@@ -50905,9 +50476,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -50931,9 +50502,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
@@ -50967,9 +50538,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -51036,9 +50607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -51102,9 +50673,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
content:
application/json:
@@ -51170,15 +50741,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
content:
application/json:
- schema: *349
+ schema: *346
examples:
default:
value:
@@ -51269,9 +50840,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'204':
description: Response
@@ -51294,9 +50865,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
@@ -51306,7 +50877,7 @@ paths:
type: array
items: *23
examples:
- default: &357
+ default: &354
value:
- id: 1
slug: octoapp
@@ -51363,9 +50934,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51399,7 +50970,7 @@ paths:
type: array
items: *23
examples:
- default: *357
+ default: *354
'422': *33
x-github:
githubCloudOnly: false
@@ -51420,9 +50991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51456,7 +51027,7 @@ paths:
type: array
items: *23
examples:
- default: *357
+ default: *354
'422': *33
x-github:
githubCloudOnly: false
@@ -51477,9 +51048,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51513,7 +51084,7 @@ paths:
type: array
items: *23
examples:
- default: *357
+ default: *354
'422': *33
x-github:
githubCloudOnly: false
@@ -51535,9 +51106,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
@@ -51545,7 +51116,7 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
default: *271
'404': *24
@@ -51567,9 +51138,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -51605,7 +51176,7 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
default: *271
'422': *33
@@ -51628,9 +51199,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: false
content:
@@ -51666,7 +51237,7 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
default: *271
'422': *33
@@ -51689,9 +51260,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
content:
application/json:
@@ -51726,7 +51297,7 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
default: *271
'422': *33
@@ -51750,9 +51321,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:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
responses:
'200':
description: Response
@@ -51786,9 +51357,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51846,9 +51417,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51906,9 +51477,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51968,9 +51539,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#rename-a-branch
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
requestBody:
required: true
content:
@@ -51992,7 +51563,7 @@ paths:
description: Response
content:
application/json:
- schema: *358
+ schema: *355
examples:
default:
value:
@@ -52105,8 +51676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -52385,7 +51956,7 @@ paths:
description: Response
content:
application/json:
- schema: &360
+ schema: &357
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -52520,8 +52091,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *359
- deployment: &611
+ items: *356
+ deployment: &606
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -52808,9 +52379,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#get-a-check-run
parameters:
- - *290
- - *291
- - &361
+ - *287
+ - *288
+ - &358
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -52822,9 +52393,9 @@ paths:
description: Response
content:
application/json:
- schema: *360
+ schema: *357
examples:
- default: &362
+ default: &359
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -52924,9 +52495,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run
parameters:
- - *290
- - *291
- - *361
+ - *287
+ - *288
+ - *358
requestBody:
required: true
content:
@@ -53166,9 +52737,9 @@ paths:
description: Response
content:
application/json:
- schema: *360
+ schema: *357
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53188,9 +52759,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-run-annotations
parameters:
- - *290
- - *291
- - *361
+ - *287
+ - *288
+ - *358
- *4
- *5
responses:
@@ -53300,9 +52871,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#rerequest-a-check-run
parameters:
- - *290
- - *291
- - *361
+ - *287
+ - *288
+ - *358
responses:
'201':
description: Response
@@ -53346,8 +52917,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -53369,7 +52940,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &364
+ schema: &361
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -53451,7 +53022,7 @@ paths:
type:
- array
- 'null'
- items: *359
+ items: *356
app:
anyOf:
- type: 'null'
@@ -53467,7 +53038,7 @@ paths:
- string
- 'null'
format: date-time
- head_commit: *363
+ head_commit: *360
latest_check_runs_count:
type: integer
check_runs_url:
@@ -53495,7 +53066,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &365
+ default: &362
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -53786,9 +53357,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *365
+ default: *362
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53807,8 +53378,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -54117,9 +53688,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite
parameters:
- - *290
- - *291
- - &366
+ - *287
+ - *288
+ - &363
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -54131,9 +53702,9 @@ paths:
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *365
+ default: *362
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -54156,17 +53727,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:
- - *290
- - *291
- - *366
- - &398
+ - *287
+ - *288
+ - *363
+ - &395
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &399
+ - &396
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -54205,9 +53776,9 @@ paths:
type: integer
check_runs:
type: array
- items: *360
+ items: *357
examples:
- default: &400
+ default: &397
value:
total_count: 1
check_runs:
@@ -54309,9 +53880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *290
- - *291
- - *366
+ - *287
+ - *288
+ - *363
responses:
'201':
description: Response
@@ -54344,20 +53915,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:
- - *290
- - *291
+ - *287
+ - *288
- *177
- *178
- *5
- *4
- - &378
+ - &375
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: *367
+ schema: *364
- *9
- name: sort
description: The property by which to sort the results.
@@ -54380,7 +53951,7 @@ paths:
be returned.
in: query
required: false
- schema: *368
+ schema: *365
responses:
'200':
description: Response
@@ -54396,7 +53967,7 @@ paths:
updated_at: *98
url: *95
html_url: *96
- instances_url: *369
+ instances_url: *366
state: *90
fixed_at: *100
dismissed_by:
@@ -54404,11 +53975,11 @@ paths:
- type: 'null'
- *17
dismissed_at: *99
- dismissed_reason: *370
- dismissed_comment: *371
- rule: *372
- tool: *373
- most_recent_instance: *374
+ dismissed_reason: *367
+ dismissed_comment: *368
+ rule: *369
+ tool: *370
+ most_recent_instance: *371
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -54531,7 +54102,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *40
- '403': &375
+ '403': &372
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -54558,9 +54129,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:
- - *290
- - *291
- - &376
+ - *287
+ - *288
+ - &373
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -54574,7 +54145,7 @@ paths:
description: Response
content:
application/json:
- schema: &377
+ schema: &374
type: object
properties:
number: *91
@@ -54582,7 +54153,7 @@ paths:
updated_at: *98
url: *95
html_url: *96
- instances_url: *369
+ instances_url: *366
state: *90
fixed_at: *100
dismissed_by:
@@ -54590,8 +54161,8 @@ paths:
- type: 'null'
- *17
dismissed_at: *99
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_reason: *367
+ dismissed_comment: *368
rule:
type: object
properties:
@@ -54653,8 +54224,8 @@ paths:
- 'null'
description: A link to the documentation for the rule used
to detect the alert.
- tool: *373
- most_recent_instance: *374
+ tool: *370
+ most_recent_instance: *371
dismissal_approved_by:
anyOf:
- type: 'null'
@@ -54750,7 +54321,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *40
- '403': *375
+ '403': *372
'404': *24
'503': *102
x-github:
@@ -54770,9 +54341,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:
- - *290
- - *291
- - *376
+ - *287
+ - *288
+ - *373
requestBody:
required: true
content:
@@ -54787,8 +54358,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_reason: *367
+ dismissed_comment: *368
assignees:
description: The list of users to assign to the code scanning alert.
An empty array unassigns all previous assignees from the alert.
@@ -54814,7 +54385,7 @@ paths:
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
default:
value:
@@ -54890,7 +54461,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *32
- '403': &386
+ '403': &383
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -54917,12 +54488,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:
- - *290
- - *291
- - *376
+ - *287
+ - *288
+ - *373
- *5
- *4
- - *378
+ - *375
responses:
'200':
description: Response
@@ -54933,10 +54504,10 @@ paths:
items:
type: object
properties:
- ref: *367
- analysis_key: *379
- environment: *380
- category: *381
+ ref: *364
+ analysis_key: *376
+ environment: *377
+ category: *378
state:
type:
- string
@@ -54953,7 +54524,7 @@ paths:
properties:
text:
type: string
- location: *382
+ location: *379
html_url:
type: string
classifications:
@@ -54961,7 +54532,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: *383
+ items: *380
examples:
default:
value:
@@ -55000,7 +54571,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *375
+ '403': *372
'404': *24
'503': *102
x-github:
@@ -55034,8 +54605,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:
- - *290
- - *291
+ - *287
+ - *288
- *177
- *178
- *5
@@ -55046,12 +54617,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: *367
+ schema: *364
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &384
+ schema: &381
type: string
description: An identifier for the upload.
examples:
@@ -55073,23 +54644,23 @@ paths:
application/json:
schema:
type: array
- items: &385
+ items: &382
type: object
properties:
- ref: *367
- commit_sha: &387
+ ref: *364
+ commit_sha: &384
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: *379
+ analysis_key: *376
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *381
+ category: *378
error:
type: string
examples:
@@ -55114,8 +54685,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *384
- tool: *373
+ sarif_id: *381
+ tool: *370
deletable:
type: boolean
warning:
@@ -55177,7 +54748,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *375
+ '403': *372
'404': *24
'503': *102
x-github:
@@ -55213,8 +54784,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:
- - *290
- - *291
+ - *287
+ - *288
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -55227,7 +54798,7 @@ paths:
description: Response
content:
application/json:
- schema: *385
+ schema: *382
examples:
response:
summary: application/json response
@@ -55281,7 +54852,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *375
+ '403': *372
'404': *24
'503': *102
x-github:
@@ -55363,8 +54934,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:
- - *290
- - *291
+ - *287
+ - *288
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -55420,7 +54991,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': *32
- '403': *386
+ '403': *383
'404': *24
'503': *102
x-github:
@@ -55442,8 +55013,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -55509,7 +55080,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *375
+ '403': *372
'404': *24
'503': *102
x-github:
@@ -55530,8 +55101,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -55602,7 +55173,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *386
+ '403': *383
'404': *24
'409':
description: Response if there is already a validation run in progress with
@@ -55673,8 +55244,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -55682,7 +55253,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *387
+ commit_sha: *384
ref:
type: string
description: |-
@@ -55737,7 +55308,7 @@ paths:
schema:
type: object
properties:
- id: *384
+ id: *381
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -55751,7 +55322,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': *386
+ '403': *383
'404': *24
'413':
description: Payload Too Large if the sarif field is too large
@@ -55774,8 +55345,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:
- - *290
- - *291
+ - *287
+ - *288
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -55823,7 +55394,7 @@ paths:
value:
processing_status: complete
analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6
- '403': *375
+ '403': *372
'404':
description: Not Found if the sarif id does not match any upload
'503': *102
@@ -55848,8 +55419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-codeowners-errors
parameters:
- - *290
- - *291
+ - *287
+ - *288
- 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
@@ -55980,8 +55551,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -56019,7 +55590,7 @@ paths:
application/json:
schema:
type: array
- items: &388
+ items: &385
title: Collaborator
description: Collaborator
type: object
@@ -56211,8 +55782,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:
- - *290
- - *291
+ - *287
+ - *288
- *8
responses:
'204':
@@ -56249,8 +55820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *8
requestBody:
required: false
@@ -56320,8 +55891,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *8
responses:
'204':
@@ -56353,8 +55924,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:
- - *290
- - *291
+ - *287
+ - *288
- *8
responses:
'200':
@@ -56375,7 +55946,7 @@ paths:
user:
anyOf:
- type: 'null'
- - *388
+ - *385
required:
- permission
- role_name
@@ -56429,8 +56000,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:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -56440,7 +56011,7 @@ paths:
application/json:
schema:
type: array
- items: &389
+ items: &386
title: Commit Comment
description: Commit Comment
type: object
@@ -56498,7 +56069,7 @@ paths:
- created_at
- updated_at
examples:
- default: &394
+ default: &391
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -56557,17 +56128,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'200':
description: Response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: &395
+ default: &392
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -56624,8 +56195,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#update-a-commit-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -56648,7 +56219,7 @@ paths:
description: Response
content:
application/json:
- schema: *389
+ schema: *386
examples:
default:
value:
@@ -56699,8 +56270,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#delete-a-commit-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'204':
@@ -56722,8 +56293,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -56750,7 +56321,7 @@ paths:
application/json:
schema:
type: array
- items: &390
+ items: &387
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -56794,7 +56365,7 @@ paths:
- content
- created_at
examples:
- default: &450
+ default: &447
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -56839,8 +56410,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -56873,9 +56444,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: &391
+ default: &388
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -56904,9 +56475,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'422': *33
x-github:
githubCloudOnly: false
@@ -56928,10 +56499,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
- - &451
+ - &448
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -56986,8 +56557,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -57043,9 +56614,9 @@ paths:
application/json:
schema:
type: array
- items: *392
+ items: *389
examples:
- default: &496
+ default: &493
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -57138,9 +56709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *290
- - *291
- - &393
+ - *287
+ - *288
+ - &390
name: commit_sha
description: The SHA of the commit.
in: path
@@ -57212,9 +56783,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments
parameters:
- - *290
- - *291
- - *393
+ - *287
+ - *288
+ - *390
- *4
- *5
responses:
@@ -57224,9 +56795,9 @@ paths:
application/json:
schema:
type: array
- items: *389
+ items: *386
examples:
- default: *394
+ default: *391
headers:
Link: *6
x-github:
@@ -57254,9 +56825,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#create-a-commit-comment
parameters:
- - *290
- - *291
- - *393
+ - *287
+ - *288
+ - *390
requestBody:
required: true
content:
@@ -57291,9 +56862,9 @@ paths:
description: Response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: *395
+ default: *392
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -57321,9 +56892,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:
- - *290
- - *291
- - *393
+ - *287
+ - *288
+ - *390
- *4
- *5
responses:
@@ -57333,7 +56904,7 @@ paths:
application/json:
schema:
type: array
- items: &488
+ items: &485
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -57508,7 +57079,7 @@ paths:
type:
- array
- 'null'
- items: *292
+ items: *289
head:
type: object
properties:
@@ -57570,7 +57141,7 @@ paths:
- review_comment
- self
author_association: *106
- auto_merge: *396
+ auto_merge: *393
draft:
description: Indicates whether or not the pull request is a
draft.
@@ -57610,7 +57181,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &489
+ default: &486
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -58147,11 +57718,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#get-a-commit
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *5
- *4
- - &397
+ - &394
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)"
@@ -58166,9 +57737,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: &474
+ default: &471
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -58278,11 +57849,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:
- - *290
- - *291
- - *397
- - *398
- - *399
+ - *287
+ - *288
+ - *394
+ - *395
+ - *396
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -58316,9 +57887,9 @@ paths:
type: integer
check_runs:
type: array
- items: *360
+ items: *357
examples:
- default: *400
+ default: *397
headers:
Link: *6
x-github:
@@ -58343,9 +57914,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:
- - *290
- - *291
- - *397
+ - *287
+ - *288
+ - *394
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -58353,7 +57924,7 @@ paths:
schema:
type: integer
example: 1
- - *398
+ - *395
- *4
- *5
responses:
@@ -58371,7 +57942,7 @@ paths:
type: integer
check_suites:
type: array
- items: *364
+ items: *361
examples:
default:
value:
@@ -58571,9 +58142,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:
- - *290
- - *291
- - *397
+ - *287
+ - *288
+ - *394
- *4
- *5
responses:
@@ -58775,9 +58346,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:
- - *290
- - *291
- - *397
+ - *287
+ - *288
+ - *394
- *4
- *5
responses:
@@ -58787,7 +58358,7 @@ paths:
application/json:
schema:
type: array
- items: &529
+ items: &526
title: Status
description: The status of a commit.
type: object
@@ -58868,7 +58439,7 @@ paths:
site_admin: false
headers:
Link: *6
- '301': *302
+ '301': *299
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -58936,8 +58507,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#compare-two-commits
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *5
- *4
- name: basehead
@@ -58985,8 +58556,8 @@ paths:
format: uri
examples:
- https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *392
- merge_base_commit: *392
+ base_commit: *389
+ merge_base_commit: *389
status:
type: string
enum:
@@ -59010,10 +58581,10 @@ paths:
- 6
commits:
type: array
- items: *392
+ items: *389
files:
type: array
- items: *401
+ items: *398
required:
- url
- html_url
@@ -59292,8 +58863,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-repository-content
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: path
description: path parameter
in: path
@@ -59446,7 +59017,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &402
+ response-if-content-is-a-file: &399
summary: Response if content is a file
value:
type: file
@@ -59583,7 +59154,7 @@ paths:
- size
- type
- url
- - &501
+ - &498
title: Content File
description: Content File
type: object
@@ -59801,7 +59372,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *402
+ response-if-content-is-a-file: *399
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -59870,7 +59441,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *24
'403': *41
- '302': &505
+ '302': &502
description: Found
'304': *40
x-github:
@@ -59894,8 +59465,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#create-or-update-file-contents
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: path
description: path parameter
in: path
@@ -59990,7 +59561,7 @@ paths:
description: Response
content:
application/json:
- schema: &403
+ schema: &400
title: File Commit
description: File Commit
type: object
@@ -60139,7 +59710,7 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
example-for-creating-a-file:
value:
@@ -60190,7 +59761,7 @@ paths:
schema:
oneOf:
- *22
- - &434
+ - &431
description: Repository rule violation was detected
type: object
properties:
@@ -60243,8 +59814,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#delete-a-file
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: path
description: path parameter
in: path
@@ -60305,7 +59876,7 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
default:
value:
@@ -60356,8 +59927,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-contributors
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -60481,8 +60052,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:
- - *290
- - *291
+ - *287
+ - *288
- *185
- *186
- *187
@@ -60494,7 +60065,7 @@ paths:
schema:
type: string
- *189
- - *404
+ - *401
- *190
- *191
- *9
@@ -60525,7 +60096,7 @@ paths:
application/json:
schema:
type: array
- items: &408
+ items: &405
type: object
description: A Dependabot alert.
properties:
@@ -60560,7 +60131,7 @@ paths:
- development
- runtime
-
- security_advisory: *405
+ security_advisory: *402
security_vulnerability: *94
url: *95
html_url: *96
@@ -60591,8 +60162,8 @@ paths:
dismissal.
maxLength: 280
fixed_at: *100
- auto_dismissed_at: *406
- dismissal_request: *407
+ auto_dismissed_at: *403
+ dismissal_request: *404
required:
- number
- state
@@ -60819,9 +60390,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *290
- - *291
- - &409
+ - *287
+ - *288
+ - &406
name: alert_number
in: path
description: |-
@@ -60836,7 +60407,7 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
default:
value:
@@ -60940,9 +60511,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *290
- - *291
- - *409
+ - *287
+ - *288
+ - *406
requestBody:
required: true
content:
@@ -60987,7 +60558,7 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
default:
value:
@@ -61116,8 +60687,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -61135,7 +60706,7 @@ paths:
type: integer
secrets:
type: array
- items: &412
+ items: &409
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -61189,16 +60760,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *410
+ schema: *407
examples:
- default: *411
+ default: *408
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61218,15 +60789,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *412
+ schema: *409
examples:
default:
value:
@@ -61252,8 +60823,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:
- - *290
- - *291
+ - *287
+ - *288
- *162
requestBody:
required: true
@@ -61306,8 +60877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *162
responses:
'204':
@@ -61330,8 +60901,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:
- - *290
- - *291
+ - *287
+ - *288
- 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
@@ -61505,8 +61076,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -61752,8 +61323,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -61836,7 +61407,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &413
+ metadata: &410
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -61875,7 +61446,7 @@ paths:
examples:
- "/src/build/package-lock.json"
additionalProperties: false
- metadata: *413
+ metadata: *410
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -61889,7 +61460,7 @@ paths:
pattern: "^pkg"
examples:
- pkg:/npm/%40actions/http-client@1.0.11
- metadata: *413
+ metadata: *410
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -62022,8 +61593,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -62064,9 +61635,9 @@ paths:
application/json:
schema:
type: array
- items: *414
+ items: *411
examples:
- default: *415
+ default: *412
headers:
Link: *6
x-github:
@@ -62132,8 +61703,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#create-a-deployment
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -62215,7 +61786,7 @@ paths:
description: Response
content:
application/json:
- schema: *414
+ schema: *411
examples:
simple-example:
summary: Simple example
@@ -62288,9 +61859,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#get-a-deployment
parameters:
- - *290
- - *291
- - &416
+ - *287
+ - *288
+ - &413
name: deployment_id
description: deployment_id parameter
in: path
@@ -62302,7 +61873,7 @@ paths:
description: Response
content:
application/json:
- schema: *414
+ schema: *411
examples:
default:
value:
@@ -62367,9 +61938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#delete-a-deployment
parameters:
- - *290
- - *291
- - *416
+ - *287
+ - *288
+ - *413
responses:
'204':
description: Response
@@ -62391,9 +61962,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *290
- - *291
- - *416
+ - *287
+ - *288
+ - *413
- *4
- *5
responses:
@@ -62403,7 +61974,7 @@ paths:
application/json:
schema:
type: array
- items: &417
+ items: &414
title: Deployment Status
description: The status of a deployment.
type: object
@@ -62567,9 +62138,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *290
- - *291
- - *416
+ - *287
+ - *288
+ - *413
requestBody:
required: true
content:
@@ -62644,9 +62215,9 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
- default: &418
+ default: &415
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -62702,9 +62273,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *290
- - *291
- - *416
+ - *287
+ - *288
+ - *413
- name: status_id
in: path
required: true
@@ -62715,9 +62286,9 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
- default: *418
+ default: *415
'404': *24
x-github:
githubCloudOnly: false
@@ -62742,8 +62313,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -62800,8 +62371,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#list-environments
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -62819,7 +62390,7 @@ paths:
- 5
environments:
type: array
- items: &420
+ items: &417
title: Environment
description: Details of a deployment environment
type: object
@@ -62881,7 +62452,7 @@ paths:
type: string
examples:
- wait_timer
- wait_timer: &422
+ wait_timer: &419
type: integer
description: The amount of time to delay a job after
the job is initially triggered. The time (in minutes)
@@ -62923,11 +62494,11 @@ paths:
items:
type: object
properties:
- type: *419
+ type: *416
reviewer:
anyOf:
- *17
- - *292
+ - *289
required:
- id
- node_id
@@ -62950,7 +62521,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &423
+ deployment_branch_policy: &420
type:
- object
- 'null'
@@ -63066,9 +62637,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#get-an-environment
parameters:
- - *290
- - *291
- - &421
+ - *287
+ - *288
+ - &418
name: environment_name
in: path
required: true
@@ -63081,9 +62652,9 @@ paths:
description: Response
content:
application/json:
- schema: *420
+ schema: *417
examples:
- default: &424
+ default: &421
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -63166,9 +62737,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
requestBody:
required: false
content:
@@ -63178,7 +62749,7 @@ paths:
- object
- 'null'
properties:
- wait_timer: *422
+ wait_timer: *419
prevent_self_review:
type: boolean
description: Whether or not a user who created the job is prevented
@@ -63197,14 +62768,14 @@ paths:
items:
type: object
properties:
- type: *419
+ type: *416
id:
type: integer
description: The id of the user or team who can review the
deployment
examples:
- 4532992
- deployment_branch_policy: *423
+ deployment_branch_policy: *420
additionalProperties: false
examples:
default:
@@ -63224,9 +62795,9 @@ paths:
description: Response
content:
application/json:
- schema: *420
+ schema: *417
examples:
- default: *424
+ default: *421
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -63250,9 +62821,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#delete-an-environment
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
responses:
'204':
description: Default response
@@ -63277,9 +62848,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *4
- *5
responses:
@@ -63298,7 +62869,7 @@ paths:
- 2
branch_policies:
type: array
- items: &425
+ items: &422
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -63359,9 +62930,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:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
requestBody:
required: true
content:
@@ -63409,9 +62980,9 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
- example-wildcard: &426
+ example-wildcard: &423
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -63453,10 +63024,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:
- - *290
- - *291
- - *421
- - &427
+ - *287
+ - *288
+ - *418
+ - &424
name: branch_policy_id
in: path
required: true
@@ -63468,9 +63039,9 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
- default: *426
+ default: *423
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63489,10 +63060,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:
- - *290
- - *291
- - *421
- - *427
+ - *287
+ - *288
+ - *418
+ - *424
requestBody:
required: true
content:
@@ -63521,9 +63092,9 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
- default: *426
+ default: *423
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63542,10 +63113,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:
- - *290
- - *291
- - *421
- - *427
+ - *287
+ - *288
+ - *418
+ - *424
responses:
'204':
description: Response
@@ -63570,9 +63141,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:
- - *421
- - *291
- - *290
+ - *418
+ - *288
+ - *287
responses:
'200':
description: List of deployment protection rules
@@ -63589,7 +63160,7 @@ paths:
- 10
custom_deployment_protection_rules:
type: array
- items: &428
+ items: &425
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -63611,7 +63182,7 @@ paths:
for the environment.
examples:
- true
- app: &429
+ app: &426
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -63714,9 +63285,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:
- - *421
- - *291
- - *290
+ - *418
+ - *288
+ - *287
requestBody:
content:
application/json:
@@ -63737,9 +63308,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *428
+ schema: *425
examples:
- default: &430
+ default: &427
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -63774,9 +63345,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:
- - *421
- - *291
- - *290
+ - *418
+ - *288
+ - *287
- *5
- *4
responses:
@@ -63796,7 +63367,7 @@ paths:
- 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *429
+ items: *426
examples:
default:
value:
@@ -63831,10 +63402,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:
- - *290
- - *291
- - *421
- - &431
+ - *287
+ - *288
+ - *418
+ - &428
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -63846,9 +63417,9 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
- default: *430
+ default: *427
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63869,10 +63440,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:
- - *421
- - *291
- - *290
- - *431
+ - *418
+ - *288
+ - *287
+ - *428
responses:
'204':
description: Response
@@ -63898,9 +63469,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-environment-secrets
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *4
- *5
responses:
@@ -63918,9 +63489,9 @@ paths:
type: integer
secrets:
type: array
- items: *327
+ items: *324
examples:
- default: *328
+ default: *325
headers:
Link: *6
x-github:
@@ -63945,17 +63516,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
responses:
'200':
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- default: *330
+ default: *327
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -63977,18 +63548,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-secret
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *327
+ schema: *324
examples:
- default: *432
+ default: *429
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64010,9 +63581,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:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *162
requestBody:
required: true
@@ -64070,9 +63641,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *162
responses:
'204':
@@ -64098,10 +63669,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-environment-variables
parameters:
- - *290
- - *291
- - *421
- - *314
+ - *287
+ - *288
+ - *418
+ - *311
- *5
responses:
'200':
@@ -64118,9 +63689,9 @@ paths:
type: integer
variables:
type: array
- items: *331
+ items: *328
examples:
- default: *332
+ default: *329
headers:
Link: *6
x-github:
@@ -64143,9 +63714,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-environment-variable
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
requestBody:
required: true
content:
@@ -64197,18 +63768,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-environment-variable
parameters:
- - *290
- - *291
- - *421
+ - *287
+ - *288
+ - *418
- *165
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: *433
+ default: *430
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64229,10 +63800,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-environment-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *165
- - *421
+ - *418
requestBody:
required: true
content:
@@ -64274,10 +63845,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-environment-variable
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *165
- - *421
+ - *418
responses:
'204':
description: Response
@@ -64299,8 +63870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-repository-events
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -64378,8 +63949,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#list-forks
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -64538,8 +64109,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#create-a-fork
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -64572,9 +64143,9 @@ paths:
description: Response
content:
application/json:
- schema: *301
+ schema: *298
examples:
- default: *303
+ default: *300
'400': *32
'422': *33
'403': *41
@@ -64595,8 +64166,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#create-a-blob
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -64656,7 +64227,7 @@ paths:
schema:
oneOf:
- *137
- - *434
+ - *431
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64681,8 +64252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#get-a-blob
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: file_sha
in: path
required: true
@@ -64782,8 +64353,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -64892,7 +64463,7 @@ paths:
description: Response
content:
application/json:
- schema: &435
+ schema: &432
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -65111,15 +64682,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#get-a-commit-object
parameters:
- - *290
- - *291
- - *393
+ - *287
+ - *288
+ - *390
responses:
'200':
description: Response
content:
application/json:
- schema: *435
+ schema: *432
examples:
default:
value:
@@ -65172,9 +64743,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#list-matching-references
parameters:
- - *290
- - *291
- - &436
+ - *287
+ - *288
+ - &433
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.
@@ -65191,7 +64762,7 @@ paths:
application/json:
schema:
type: array
- items: &437
+ items: &434
title: Git Reference
description: Git references within a repository
type: object
@@ -65267,17 +64838,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference
parameters:
- - *290
- - *291
- - *436
+ - *287
+ - *288
+ - *433
responses:
'200':
description: Response
content:
application/json:
- schema: *437
+ schema: *434
examples:
- default: &438
+ default: &435
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -65306,8 +64877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -65336,9 +64907,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *434
examples:
- default: *438
+ default: *435
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -65364,9 +64935,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference
parameters:
- - *290
- - *291
- - *436
+ - *287
+ - *288
+ - *433
requestBody:
required: true
content:
@@ -65395,9 +64966,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *434
examples:
- default: *438
+ default: *435
'422': *33
'409': *139
x-github:
@@ -65415,9 +64986,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#delete-a-reference
parameters:
- - *290
- - *291
- - *436
+ - *287
+ - *288
+ - *433
responses:
'204':
description: Response
@@ -65472,8 +65043,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#create-a-tag-object
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -65540,7 +65111,7 @@ paths:
description: Response
content:
application/json:
- schema: &440
+ schema: &437
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -65596,7 +65167,7 @@ paths:
- sha
- type
- url
- verification: *439
+ verification: *436
required:
- sha
- url
@@ -65606,7 +65177,7 @@ paths:
- tag
- message
examples:
- default: &441
+ default: &438
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -65676,8 +65247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#get-a-tag
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: tag_sha
in: path
required: true
@@ -65688,9 +65259,9 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *437
examples:
- default: *441
+ default: *438
'404': *24
'409': *139
x-github:
@@ -65714,8 +65285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#create-a-tree
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -65789,7 +65360,7 @@ paths:
description: Response
content:
application/json:
- schema: &442
+ schema: &439
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -65891,8 +65462,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -65915,7 +65486,7 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
default-response:
summary: Default response
@@ -65974,8 +65545,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -65985,7 +65556,7 @@ paths:
application/json:
schema:
type: array
- items: &443
+ items: &440
title: Webhook
description: Webhooks for repositories.
type: object
@@ -66048,7 +65619,7 @@ paths:
format: uri
examples:
- https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &639
+ last_response: &634
title: Hook Response
type: object
properties:
@@ -66125,8 +65696,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -66179,9 +65750,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: &444
+ default: &441
value:
type: Repository
id: 12345678
@@ -66229,17 +65800,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *3
responses:
'200':
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'404': *24
x-github:
githubCloudOnly: false
@@ -66259,8 +65830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *3
requestBody:
required: true
@@ -66306,9 +65877,9 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
- default: *444
+ default: *441
'422': *33
'404': *24
x-github:
@@ -66329,8 +65900,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *3
responses:
'204':
@@ -66355,8 +65926,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:
- - *290
- - *291
+ - *287
+ - *288
- *3
responses:
'200':
@@ -66384,8 +65955,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:
- - *290
- - *291
+ - *287
+ - *288
- *3
requestBody:
required: false
@@ -66430,8 +66001,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:
- - *290
- - *291
+ - *287
+ - *288
- *3
- *4
- *199
@@ -66463,8 +66034,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:
- - *290
- - *291
+ - *287
+ - *288
- *3
- *34
responses:
@@ -66493,8 +66064,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:
- - *290
- - *291
+ - *287
+ - *288
- *3
- *34
responses:
@@ -66518,8 +66089,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *3
responses:
'204':
@@ -66545,8 +66116,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *3
responses:
'204':
@@ -66571,8 +66142,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -66580,8 +66151,8 @@ paths:
application/json:
schema: *37
examples:
- default: *445
- '301': *302
+ default: *442
+ '301': *299
'404': *24
x-github:
githubCloudOnly: false
@@ -66600,8 +66171,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -66611,7 +66182,7 @@ paths:
application/json:
schema:
type: array
- items: &446
+ items: &443
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -66673,7 +66244,7 @@ paths:
- html_url
- created_at
examples:
- default: &590
+ default: &585
value:
- id: 1
repository:
@@ -66804,9 +66375,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *290
- - *291
- - &447
+ - *287
+ - *288
+ - &444
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -66841,7 +66412,7 @@ paths:
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -66972,9 +66543,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *290
- - *291
- - *447
+ - *287
+ - *288
+ - *444
responses:
'204':
description: Response
@@ -67005,8 +66576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-repository-issues
parameters:
- - *290
- - *291
+ - *287
+ - *288
- 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
@@ -67227,7 +66798,7 @@ paths:
state_reason: completed
headers:
Link: *6
- '301': *302
+ '301': *299
'422': *33
'404': *24
x-github:
@@ -67256,8 +66827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#create-an-issue
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -67349,7 +66920,7 @@ paths:
application/json:
schema: *105
examples:
- default: &453
+ default: &450
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -67533,9 +67104,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:
- - *290
- - *291
- - &494
+ - *287
+ - *288
+ - &491
name: sort
description: The property to sort the results by.
in: query
@@ -67565,9 +67136,9 @@ paths:
application/json:
schema:
type: array
- items: *448
+ items: *445
examples:
- default: &455
+ default: &452
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -67625,17 +67196,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'200':
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: &449
+ default: &446
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -67689,8 +67260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#update-an-issue-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -67713,9 +67284,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *449
+ default: *446
'422': *33
x-github:
githubCloudOnly: false
@@ -67733,8 +67304,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#delete-an-issue-comment
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'204':
@@ -67755,8 +67326,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -67783,9 +67354,9 @@ paths:
application/json:
schema:
type: array
- items: *390
+ items: *387
examples:
- default: *450
+ default: *447
headers:
Link: *6
'404': *24
@@ -67806,8 +67377,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -67840,16 +67411,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'201':
description: Reaction created
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'422': *33
x-github:
githubCloudOnly: false
@@ -67871,10 +67442,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *122
- - *451
+ - *448
responses:
'204':
description: Response
@@ -67894,8 +67465,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:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -67905,7 +67476,7 @@ paths:
application/json:
schema:
type: array
- items: &452
+ items: &449
title: Issue Event
description: Issue Event
type: object
@@ -67985,7 +67556,7 @@ paths:
anyOf:
- type: 'null'
- *17
- requested_team: *292
+ requested_team: *289
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -68244,8 +67815,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#get-an-issue-event
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: event_id
in: path
required: true
@@ -68256,7 +67827,7 @@ paths:
description: Response
content:
application/json:
- schema: *452
+ schema: *449
examples:
default:
value:
@@ -68482,9 +68053,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue
parameters:
- - *290
- - *291
- - &454
+ - *287
+ - *288
+ - &451
name: issue_number
description: The number that identifies the issue.
in: path
@@ -68498,8 +68069,8 @@ paths:
application/json:
schema: *105
examples:
- default: *453
- '301': *302
+ default: *450
+ '301': *299
'404': *24
'410': *233
'304': *40
@@ -68526,9 +68097,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#update-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: false
content:
@@ -68649,11 +68220,11 @@ paths:
application/json:
schema: *105
examples:
- default: *453
+ default: *450
'422': *33
'503': *102
'403': *41
- '301': *302
+ '301': *299
'404': *24
'410': *233
x-github:
@@ -68673,9 +68244,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: false
content:
@@ -68703,7 +68274,7 @@ paths:
application/json:
schema: *105
examples:
- default: *453
+ default: *450
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68719,9 +68290,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
content:
application/json:
@@ -68748,7 +68319,7 @@ paths:
application/json:
schema: *105
examples:
- default: *453
+ default: *450
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68770,9 +68341,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:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- name: assignee
in: path
required: true
@@ -68812,9 +68383,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- *113
- *4
- *5
@@ -68825,9 +68396,9 @@ paths:
application/json:
schema:
type: array
- items: *448
+ items: *445
examples:
- default: *455
+ default: *452
headers:
Link: *6
'404': *24
@@ -68860,9 +68431,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: true
content:
@@ -68884,9 +68455,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *449
+ default: *446
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
@@ -68913,9 +68484,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- *4
- *5
responses:
@@ -68929,7 +68500,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &457
+ - &454
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -68978,7 +68549,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &458
+ - &455
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -69106,7 +68677,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &459
+ - &456
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -69152,7 +68723,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &460
+ - &457
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -69198,7 +68769,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &461
+ - &458
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -69247,7 +68818,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &462
+ - &459
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -69276,7 +68847,7 @@ paths:
- type: 'null'
- *23
review_requester: *17
- requested_team: *292
+ requested_team: *289
requested_reviewer: *17
required:
- review_requester
@@ -69289,7 +68860,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &463
+ - &460
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -69318,7 +68889,7 @@ paths:
- type: 'null'
- *23
review_requester: *17
- requested_team: *292
+ requested_team: *289
requested_reviewer: *17
required:
- review_requester
@@ -69331,7 +68902,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &464
+ - &461
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -69387,7 +68958,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &465
+ - &462
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -69432,7 +69003,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &466
+ - &463
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -69493,7 +69064,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &467
+ - &464
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -69554,7 +69125,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &468
+ - &465
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -69615,7 +69186,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &469
+ - &466
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -69725,9 +69296,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- *4
- *5
responses:
@@ -69739,7 +69310,7 @@ paths:
type: array
items: *104
examples:
- default: &456
+ default: &453
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -69757,7 +69328,7 @@ paths:
default: false
headers:
Link: *6
- '301': *302
+ '301': *299
'404': *24
'410': *233
x-github:
@@ -69776,9 +69347,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: false
content:
@@ -69839,8 +69410,8 @@ paths:
type: array
items: *104
examples:
- default: *456
- '301': *302
+ default: *453
+ '301': *299
'404': *24
'410': *233
'422': *33
@@ -69859,9 +69430,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: false
content:
@@ -69923,8 +69494,8 @@ paths:
type: array
items: *104
examples:
- default: *456
- '301': *302
+ default: *453
+ '301': *299
'404': *24
'410': *233
'422': *33
@@ -69943,13 +69514,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:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
responses:
'204':
description: Response
- '301': *302
+ '301': *299
'404': *24
'410': *233
x-github:
@@ -69970,9 +69541,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:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- name: name
in: path
required: true
@@ -69996,7 +69567,7 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *302
+ '301': *299
'404': *24
'410': *233
x-github:
@@ -70018,9 +69589,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#lock-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: false
content:
@@ -70067,9 +69638,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#unlock-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
responses:
'204':
description: Response
@@ -70091,9 +69662,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- 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.
@@ -70119,9 +69690,9 @@ paths:
application/json:
schema:
type: array
- items: *390
+ items: *387
examples:
- default: *450
+ default: *447
headers:
Link: *6
'404': *24
@@ -70143,9 +69714,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
requestBody:
required: true
content:
@@ -70177,16 +69748,16 @@ paths:
description: Response
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'201':
description: Response
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'422': *33
x-github:
githubCloudOnly: false
@@ -70208,10 +69779,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *290
- - *291
- - *454
+ - *287
+ - *288
- *451
+ - *448
responses:
'204':
description: Response
@@ -70231,9 +69802,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:
- - *290
- - *291
- - *454
+ - *287
+ - *288
+ - *451
- *4
- *5
responses:
@@ -70248,6 +69819,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *454
+ - *455
+ - *456
- *457
- *458
- *459
@@ -70258,9 +69832,6 @@ paths:
- *464
- *465
- *466
- - *467
- - *468
- - *469
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -70584,7 +70155,7 @@ paths:
type: string
comments:
type: array
- items: &490
+ items: &487
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -70822,7 +70393,7 @@ paths:
type: string
comments:
type: array
- items: *389
+ items: *386
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -71114,8 +70685,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -71125,7 +70696,7 @@ paths:
application/json:
schema:
type: array
- items: &470
+ items: &467
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -71191,8 +70762,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -71228,9 +70799,9 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
- default: &471
+ default: &468
value:
id: 1
key: ssh-rsa AAA...
@@ -71263,9 +70834,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:
- - *290
- - *291
- - &472
+ - *287
+ - *288
+ - &469
name: key_id
description: The unique identifier of the key.
in: path
@@ -71277,9 +70848,9 @@ paths:
description: Response
content:
application/json:
- schema: *470
+ schema: *467
examples:
- default: *471
+ default: *468
'404': *24
x-github:
githubCloudOnly: false
@@ -71297,9 +70868,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:
- - *290
- - *291
- - *472
+ - *287
+ - *288
+ - *469
responses:
'204':
description: Response
@@ -71319,8 +70890,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -71332,7 +70903,7 @@ paths:
type: array
items: *104
examples:
- default: *456
+ default: *453
headers:
Link: *6
'404': *24
@@ -71353,8 +70924,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#create-a-label
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -71392,7 +70963,7 @@ paths:
application/json:
schema: *104
examples:
- default: &473
+ default: &470
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -71424,8 +70995,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#get-a-label
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: name
in: path
required: true
@@ -71438,7 +71009,7 @@ paths:
application/json:
schema: *104
examples:
- default: *473
+ default: *470
'404': *24
x-github:
githubCloudOnly: false
@@ -71455,8 +71026,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#update-a-label
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: name
in: path
required: true
@@ -71521,8 +71092,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#delete-a-label
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: name
in: path
required: true
@@ -71548,8 +71119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-languages
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -71585,8 +71156,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'202': *140
'403':
@@ -71614,8 +71185,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -71641,9 +71212,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:
- - *290
- - *291
- - *378
+ - *287
+ - *288
+ - *375
responses:
'200':
description: Response
@@ -71790,8 +71361,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -71856,8 +71427,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#merge-a-branch
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -71891,9 +71462,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: *474
+ default: *471
'204':
description: Response when already merged
'404':
@@ -71918,8 +71489,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#list-milestones
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -72016,8 +71587,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#create-a-milestone
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -72059,7 +71630,7 @@ paths:
application/json:
schema: *109
examples:
- default: &475
+ default: &472
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -72118,9 +71689,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#get-a-milestone
parameters:
- - *290
- - *291
- - &476
+ - *287
+ - *288
+ - &473
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -72134,7 +71705,7 @@ paths:
application/json:
schema: *109
examples:
- default: *475
+ default: *472
'404': *24
x-github:
githubCloudOnly: false
@@ -72151,9 +71722,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#update-a-milestone
parameters:
- - *290
- - *291
- - *476
+ - *287
+ - *288
+ - *473
requestBody:
required: false
content:
@@ -72193,7 +71764,7 @@ paths:
application/json:
schema: *109
examples:
- default: *475
+ default: *472
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72209,9 +71780,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#delete-a-milestone
parameters:
- - *290
- - *291
- - *476
+ - *287
+ - *288
+ - *473
responses:
'204':
description: Response
@@ -72232,9 +71803,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:
- - *290
- - *291
- - *476
+ - *287
+ - *288
+ - *473
- *4
- *5
responses:
@@ -72246,7 +71817,7 @@ paths:
type: array
items: *104
examples:
- default: *456
+ default: *453
headers:
Link: *6
x-github:
@@ -72265,12 +71836,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:
- - *290
- - *291
- - *477
- - *478
+ - *287
+ - *288
+ - *474
+ - *475
- *113
- - *479
+ - *476
- *4
- *5
responses:
@@ -72282,7 +71853,7 @@ paths:
type: array
items: *130
examples:
- default: *480
+ default: *477
headers:
Link: *6
x-github:
@@ -72306,8 +71877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -72365,14 +71936,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: &481
+ schema: &478
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -72516,7 +72087,7 @@ paths:
- custom_404
- public
examples:
- default: &482
+ default: &479
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -72557,8 +72128,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -72613,9 +72184,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *478
examples:
- default: *482
+ default: *479
'422': *33
'409': *139
x-github:
@@ -72638,8 +72209,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -72739,8 +72310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -72766,8 +72337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -72777,7 +72348,7 @@ paths:
application/json:
schema:
type: array
- items: &483
+ items: &480
title: Page Build
description: Page Build
type: object
@@ -72869,8 +72440,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'201':
description: Response
@@ -72917,16 +72488,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-latest-pages-build
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *483
+ schema: *480
examples:
- default: &484
+ default: &481
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -72974,8 +72545,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-apiname-pages-build
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: build_id
in: path
required: true
@@ -72986,9 +72557,9 @@ paths:
description: Response
content:
application/json:
- schema: *483
+ schema: *480
examples:
- default: *484
+ default: *481
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73008,8 +72579,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -73112,9 +72683,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:
- - *290
- - *291
- - &485
+ - *287
+ - *288
+ - &482
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -73172,9 +72743,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *290
- - *291
- - *485
+ - *287
+ - *288
+ - *482
responses:
'204': *229
'404': *24
@@ -73197,8 +72768,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:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
- *9
@@ -73219,7 +72790,7 @@ paths:
application/json:
schema:
type: array
- items: &486
+ items: &483
type: object
properties:
id:
@@ -73253,17 +72824,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:
- - *290
- - *291
+ - *287
+ - *288
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: &487
+ default: &484
value:
id: 42
name: Check Commits
@@ -73285,15 +72856,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:
- - *290
- - *291
+ - *287
+ - *288
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
default:
value:
@@ -73337,8 +72908,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:
- - *290
- - *291
+ - *287
+ - *288
- *16
responses:
'200':
@@ -73346,9 +72917,9 @@ paths:
global level.
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: *487
+ default: *484
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73368,8 +72939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#list-repository-projects
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -73454,8 +73025,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#create-a-repository-project
deprecated: true
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -73483,7 +73054,7 @@ paths:
application/json:
schema: *232
examples:
- default: *299
+ default: *296
'401': *39
'403': *41
'404': *24
@@ -73507,8 +73078,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -73547,8 +73118,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -73610,8 +73181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -73671,9 +73242,9 @@ paths:
application/json:
schema:
type: array
- items: *488
+ items: *485
examples:
- default: *489
+ default: *486
headers:
Link: *6
'304': *40
@@ -73705,8 +73276,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#create-a-pull-request
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -73775,7 +73346,7 @@ paths:
application/json:
schema: *111
examples:
- default: &492
+ default: &489
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -74302,8 +73873,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:
- - *290
- - *291
+ - *287
+ - *288
- name: sort
in: query
required: false
@@ -74332,9 +73903,9 @@ paths:
application/json:
schema:
type: array
- items: *490
+ items: *487
examples:
- default: &495
+ default: &492
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -74411,17 +73982,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'200':
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: &491
+ default: &488
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -74496,8 +74067,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -74520,9 +74091,9 @@ paths:
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: *491
+ default: *488
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74538,8 +74109,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
responses:
'204':
@@ -74561,8 +74132,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -74589,9 +74160,9 @@ paths:
application/json:
schema:
type: array
- items: *390
+ items: *387
examples:
- default: *450
+ default: *447
headers:
Link: *6
'404': *24
@@ -74612,8 +74183,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
requestBody:
required: true
@@ -74646,16 +74217,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'201':
description: Reaction created
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'422': *33
x-github:
githubCloudOnly: false
@@ -74677,10 +74248,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:
- - *290
- - *291
+ - *287
+ - *288
- *122
- - *451
+ - *448
responses:
'204':
description: Response
@@ -74723,9 +74294,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request
parameters:
- - *290
- - *291
- - &493
+ - *287
+ - *288
+ - &490
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -74740,7 +74311,7 @@ paths:
application/json:
schema: *111
examples:
- default: *492
+ default: *489
'304': *40
'404': *24
'406':
@@ -74775,9 +74346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request
parameters:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: false
content:
@@ -74821,7 +74392,7 @@ paths:
application/json:
schema: *111
examples:
- default: *492
+ default: *489
'422': *33
'403': *41
x-github:
@@ -74849,10 +74420,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:
- - *290
- - *291
- - *493
- - *494
+ - *287
+ - *288
+ - *490
+ - *491
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
in: query
@@ -74872,9 +74443,9 @@ paths:
application/json:
schema:
type: array
- items: *490
+ items: *487
examples:
- default: *495
+ default: *492
headers:
Link: *6
x-github:
@@ -74907,9 +74478,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: true
content:
@@ -75015,7 +74586,7 @@ paths:
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
example-for-a-multi-line-comment:
value:
@@ -75103,9 +74674,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
- *122
requestBody:
required: true
@@ -75128,7 +74699,7 @@ paths:
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
default:
value:
@@ -75214,9 +74785,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
- *4
- *5
responses:
@@ -75226,9 +74797,9 @@ paths:
application/json:
schema:
type: array
- items: *392
+ items: *389
examples:
- default: *496
+ default: *493
headers:
Link: *6
x-github:
@@ -75258,9 +74829,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
- *4
- *5
responses:
@@ -75270,7 +74841,7 @@ paths:
application/json:
schema:
type: array
- items: *401
+ items: *398
examples:
default:
value:
@@ -75308,9 +74879,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
responses:
'204':
description: Response if pull request has been merged
@@ -75333,9 +74904,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: false
content:
@@ -75447,9 +75018,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
responses:
'200':
description: Response
@@ -75465,7 +75036,7 @@ paths:
items: *17
teams:
type: array
- items: *292
+ items: *289
required:
- users
- teams
@@ -75524,9 +75095,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: false
content:
@@ -75563,7 +75134,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
default:
value:
@@ -76099,9 +75670,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: true
content:
@@ -76135,7 +75706,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
default:
value:
@@ -76640,9 +76211,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
- *4
- *5
responses:
@@ -76652,7 +76223,7 @@ paths:
application/json:
schema:
type: array
- items: &497
+ items: &494
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -76808,9 +76379,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:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: false
content:
@@ -76900,9 +76471,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &499
+ default: &496
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -76965,10 +76536,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:
- - *290
- - *291
- - *493
- - &498
+ - *287
+ - *288
+ - *490
+ - &495
name: review_id
description: The unique identifier of the review.
in: path
@@ -76980,9 +76551,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &500
+ default: &497
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -77041,10 +76612,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:
- - *290
- - *291
- - *493
- - *498
+ - *287
+ - *288
+ - *490
+ - *495
requestBody:
required: true
content:
@@ -77067,7 +76638,7 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
default:
value:
@@ -77129,18 +76700,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:
- - *290
- - *291
- - *493
- - *498
+ - *287
+ - *288
+ - *490
+ - *495
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *499
+ default: *496
'422': *25
'404': *24
x-github:
@@ -77167,10 +76738,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:
- - *290
- - *291
- - *493
- - *498
+ - *287
+ - *288
+ - *490
+ - *495
- *4
- *5
responses:
@@ -77428,10 +76999,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:
- - *290
- - *291
- - *493
- - *498
+ - *287
+ - *288
+ - *490
+ - *495
requestBody:
required: true
content:
@@ -77460,7 +77031,7 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
default:
value:
@@ -77523,10 +77094,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:
- - *290
- - *291
- - *493
- - *498
+ - *287
+ - *288
+ - *490
+ - *495
requestBody:
required: true
content:
@@ -77561,9 +77132,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *500
+ default: *497
'404': *24
'422': *25
'403': *41
@@ -77585,9 +77156,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *290
- - *291
- - *493
+ - *287
+ - *288
+ - *490
requestBody:
required: false
content:
@@ -77651,8 +77222,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -77665,9 +77236,9 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: &502
+ default: &499
value:
type: file
encoding: base64
@@ -77709,8 +77280,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:
- - *290
- - *291
+ - *287
+ - *288
- name: dir
description: The alternate path to look for a README file
in: path
@@ -77730,9 +77301,9 @@ paths:
description: Response
content:
application/json:
- schema: *501
+ schema: *498
examples:
- default: *502
+ default: *499
'404': *24
'422': *33
x-github:
@@ -77754,8 +77325,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#list-releases
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -77765,7 +77336,7 @@ paths:
application/json:
schema:
type: array
- items: *503
+ items: *500
examples:
default:
value:
@@ -77859,8 +77430,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -77930,9 +77501,9 @@ paths:
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: &508
+ default: &505
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -78032,9 +77603,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#get-a-release-asset
parameters:
- - *290
- - *291
- - &506
+ - *287
+ - *288
+ - &503
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -78046,9 +77617,9 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: &507
+ default: &504
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
@@ -78083,7 +77654,7 @@ paths:
type: User
site_admin: false
'404': *24
- '302': *505
+ '302': *502
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78099,9 +77670,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#update-a-release-asset
parameters:
- - *290
- - *291
- - *506
+ - *287
+ - *288
+ - *503
requestBody:
required: false
content:
@@ -78130,9 +77701,9 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: *507
+ default: *504
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78148,9 +77719,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#delete-a-release-asset
parameters:
- - *290
- - *291
- - *506
+ - *287
+ - *288
+ - *503
responses:
'204':
description: Response
@@ -78174,8 +77745,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -78261,16 +77832,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: *508
+ default: *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78287,8 +77858,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:
- - *290
- - *291
+ - *287
+ - *288
- name: tag
description: tag parameter
in: path
@@ -78301,9 +77872,9 @@ paths:
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: *508
+ default: *505
'404': *24
x-github:
githubCloudOnly: false
@@ -78325,9 +77896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release
parameters:
- - *290
- - *291
- - &509
+ - *287
+ - *288
+ - &506
name: release_id
description: The unique identifier of the release.
in: path
@@ -78341,9 +77912,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: *503
+ schema: *500
examples:
- default: *508
+ default: *505
'401':
description: Unauthorized
x-github:
@@ -78361,9 +77932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#update-a-release
parameters:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
requestBody:
required: false
content:
@@ -78420,9 +77991,9 @@ paths:
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: *508
+ default: *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78438,9 +78009,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#delete-a-release
parameters:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
responses:
'204':
description: Response
@@ -78460,9 +78031,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets
parameters:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
- *4
- *5
responses:
@@ -78472,7 +78043,7 @@ paths:
application/json:
schema:
type: array
- items: *504
+ items: *501
examples:
default:
value:
@@ -78554,9 +78125,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:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
- name: name
in: query
required: true
@@ -78582,7 +78153,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *504
+ schema: *501
examples:
response-for-successful-upload:
value:
@@ -78637,9 +78208,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
- 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.
@@ -78663,9 +78234,9 @@ paths:
application/json:
schema:
type: array
- items: *390
+ items: *387
examples:
- default: *450
+ default: *447
headers:
Link: *6
'404': *24
@@ -78686,9 +78257,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *290
- - *291
- - *509
+ - *287
+ - *288
+ - *506
requestBody:
required: true
content:
@@ -78718,16 +78289,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'201':
description: Reaction created
content:
application/json:
- schema: *390
+ schema: *387
examples:
- default: *391
+ default: *388
'422': *33
x-github:
githubCloudOnly: false
@@ -78749,10 +78320,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *290
- - *291
- - *509
- - *451
+ - *287
+ - *288
+ - *506
+ - *448
responses:
'204':
description: Response
@@ -78772,8 +78343,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -78848,9 +78419,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *290
- - *291
- - *348
+ - *287
+ - *288
+ - *345
- *4
- *5
responses:
@@ -78867,7 +78438,7 @@ paths:
oneOf:
- allOf:
- *245
- - &510
+ - &507
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -78888,49 +78459,49 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *246
- - *510
+ - *507
- allOf:
- *247
- - *510
+ - *507
- allOf:
- *248
- - *510
+ - *507
- allOf:
- *249
- - *510
+ - *507
- allOf:
- *250
- - *510
+ - *507
- allOf:
- *251
- - *510
+ - *507
- allOf:
- *252
- - *510
+ - *507
- allOf:
- *253
- - *510
+ - *507
- allOf:
- *254
- - *510
+ - *507
- allOf:
- *255
- - *510
+ - *507
- allOf:
- *256
- - *510
+ - *507
- allOf:
- *257
- - *510
+ - *507
- allOf:
- *258
- - *510
+ - *507
- allOf:
- *259
- - *510
+ - *507
- allOf:
- *260
- - *510
+ - *507
examples:
default:
value:
@@ -78969,8 +78540,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
- name: includes_parents
@@ -78981,7 +78552,7 @@ paths:
schema:
type: boolean
default: true
- - *511
+ - *508
responses:
'200':
description: Response
@@ -79036,8 +78607,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
description: Request body
required: true
@@ -79066,7 +78637,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *512
+ items: *509
required:
- name
- enforcement
@@ -79099,7 +78670,7 @@ paths:
application/json:
schema: *261
examples:
- default: &522
+ default: &519
value:
id: 42
name: super cool ruleset
@@ -79146,12 +78717,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *290
- - *291
+ - *287
+ - *288
+ - *510
+ - *511
+ - *512
- *513
- - *514
- - *515
- - *516
- *4
- *5
responses:
@@ -79159,9 +78730,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'404': *24
'500': *220
x-github:
@@ -79182,17 +78753,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:
- - *290
- - *291
- - *519
+ - *287
+ - *288
+ - *516
responses:
'200':
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *521
+ default: *518
'404': *24
'500': *220
x-github:
@@ -79220,8 +78791,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -79243,7 +78814,7 @@ paths:
application/json:
schema: *261
examples:
- default: *522
+ default: *519
'404': *24
'500': *220
put:
@@ -79261,8 +78832,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -79296,7 +78867,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *512
+ items: *509
examples:
default:
value:
@@ -79326,7 +78897,7 @@ paths:
application/json:
schema: *261
examples:
- default: *522
+ default: *519
'404': *24
'500': *220
delete:
@@ -79344,8 +78915,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -79373,8 +78944,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:
- - *290
- - *291
+ - *287
+ - *288
- *264
- *265
- *266
@@ -79382,8 +78953,8 @@ paths:
- *9
- *5
- *4
- - *523
- - *524
+ - *520
+ - *521
- *268
responses:
'200':
@@ -79392,7 +78963,7 @@ paths:
application/json:
schema:
type: array
- items: &527
+ items: &524
type: object
properties:
number: *91
@@ -79408,8 +78979,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *525
- resolution: *526
+ state: *522
+ resolution: *523
resolved_at:
type:
- string
@@ -79585,15 +79156,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:
- - *290
- - *291
- - *376
+ - *287
+ - *288
+ - *373
responses:
'200':
description: Response
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
value:
@@ -79633,9 +79204,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:
- - *290
- - *291
- - *376
+ - *287
+ - *288
+ - *373
requestBody:
required: true
content:
@@ -79643,8 +79214,8 @@ paths:
schema:
type: object
properties:
- state: *525
- resolution: *526
+ state: *522
+ resolution: *523
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -79664,7 +79235,7 @@ paths:
description: Response
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
value:
@@ -79731,9 +79302,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:
- - *290
- - *291
- - *376
+ - *287
+ - *288
+ - *373
- *5
- *4
responses:
@@ -79744,7 +79315,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &659
+ items: &654
type: object
properties:
type:
@@ -80123,8 +79694,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-stargazers
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -80217,8 +79788,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -80227,7 +79798,7 @@ paths:
application/json:
schema:
type: array
- items: &528
+ items: &525
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -80258,8 +79829,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -80334,8 +79905,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -80429,8 +80000,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -80584,8 +80155,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -80595,7 +80166,7 @@ paths:
application/json:
schema:
type: array
- items: *528
+ items: *525
examples:
default:
value:
@@ -80628,8 +80199,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#create-a-commit-status
parameters:
- - *290
- - *291
+ - *287
+ - *288
- name: sha
in: path
required: true
@@ -80685,7 +80256,7 @@ paths:
description: Response
content:
application/json:
- schema: *529
+ schema: *526
examples:
default:
value:
@@ -80739,8 +80310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-watchers
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -80772,14 +80343,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &530
+ schema: &527
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -80852,8 +80423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -80879,7 +80450,7 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *527
examples:
default:
value:
@@ -80906,8 +80477,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -80927,8 +80498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -81010,8 +80581,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Response
@@ -81019,7 +80590,7 @@ paths:
application/json:
schema:
type: array
- items: &531
+ items: &528
title: Tag protection
description: Tag protection
type: object
@@ -81076,8 +80647,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:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -81100,7 +80671,7 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
default:
value:
@@ -81131,8 +80702,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:
- - *290
- - *291
+ - *287
+ - *288
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -81169,8 +80740,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:
- - *290
- - *291
+ - *287
+ - *288
- name: ref
in: path
required: true
@@ -81206,8 +80777,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-teams
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *4
- *5
responses:
@@ -81217,7 +80788,7 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
default: *271
headers:
@@ -81239,8 +80810,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-all-repository-topics
parameters:
- - *290
- - *291
+ - *287
+ - *288
- *5
- *4
responses:
@@ -81248,7 +80819,7 @@ paths:
description: Response
content:
application/json:
- schema: &532
+ schema: &529
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -81260,7 +80831,7 @@ paths:
required:
- names
examples:
- default: &533
+ default: &530
value:
names:
- octocat
@@ -81283,8 +80854,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -81315,9 +80886,9 @@ paths:
description: Response
content:
application/json:
- schema: *532
+ schema: *529
examples:
- default: *533
+ default: *530
'404': *24
'422': *25
x-github:
@@ -81340,8 +80911,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#transfer-a-repository
parameters:
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: true
content:
@@ -81615,8 +81186,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -81639,8 +81210,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -81662,8 +81233,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -81689,8 +81260,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:
- - *290
- - *291
+ - *287
+ - *288
- name: ref
in: path
required: true
@@ -81782,9 +81353,9 @@ paths:
description: Response
content:
application/json:
- schema: *301
+ schema: *298
examples:
- default: *303
+ default: *300
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -81959,7 +81530,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &541
+ - &538
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -81969,7 +81540,7 @@ paths:
type: string
examples:
- members
- - &546
+ - &543
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -81981,7 +81552,7 @@ paths:
format: int32
examples:
- 1
- - &547
+ - &544
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -82025,7 +81596,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &535
+ items: &532
allOf:
- type: object
required:
@@ -82107,7 +81678,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: &548
+ meta: &545
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -82172,31 +81743,31 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &536
+ '400': &533
description: Bad request
content:
application/json:
- schema: *534
+ schema: *531
application/scim+json:
- schema: *534
- '401': &537
+ schema: *531
+ '401': &534
description: Authorization failure
- '403': &538
+ '403': &535
description: Permission denied
- '429': &539
+ '429': &536
description: Too many requests
content:
application/json:
- schema: *534
+ schema: *531
application/scim+json:
- schema: *534
- '500': &540
+ schema: *531
+ '500': &537
description: Internal server error
content:
application/json:
- schema: *534
+ schema: *531
application/scim+json:
- schema: *534
+ schema: *531
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82223,7 +81794,7 @@ paths:
required: true
content:
application/json:
- schema: &544
+ schema: &541
type: object
required:
- schemas
@@ -82287,9 +81858,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *535
+ schema: *532
examples:
- group: &542
+ group: &539
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -82308,13 +81879,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': *536
- '401': *537
- '403': *538
- '409': &545
+ '400': *533
+ '401': *534
+ '403': *535
+ '409': &542
description: Duplicate record detected
- '429': *539
- '500': *540
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82335,7 +81906,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:
- - &543
+ - &540
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -82344,22 +81915,22 @@ paths:
type: string
examples:
- 7fce0092-d52e-4f76-b727-3955bd72c939
- - *541
+ - *538
- *63
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *535
+ schema: *532
examples:
- default: *542
- '400': *536
- '401': *537
- '403': *538
+ default: *539
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '429': *539
- '500': *540
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82381,13 +81952,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:
- - *543
+ - *540
- *63
requestBody:
required: true
content:
application/json:
- schema: *544
+ schema: *541
examples:
group:
summary: Group
@@ -82413,17 +81984,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *535
+ schema: *532
examples:
- group: *542
- groupWithMembers: *542
- '400': *536
- '401': *537
- '403': *538
+ group: *539
+ groupWithMembers: *539
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '409': *545
- '429': *539
- '500': *540
+ '409': *542
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82447,13 +82018,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:
- - *543
+ - *540
- *63
requestBody:
required: true
content:
application/json:
- schema: &555
+ schema: &552
type: object
required:
- Operations
@@ -82513,17 +82084,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *535
+ schema: *532
examples:
- updateGroup: *542
- addMembers: *542
- '400': *536
- '401': *537
- '403': *538
+ updateGroup: *539
+ addMembers: *539
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '409': *545
- '429': *539
- '500': *540
+ '409': *542
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82543,17 +82114,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:
- - *543
+ - *540
- *63
responses:
'204':
description: Group was deleted, no content
- '400': *536
- '401': *537
- '403': *538
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '429': *539
- '500': *540
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82590,8 +82161,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *546
- - *547
+ - *543
+ - *544
- *63
responses:
'200':
@@ -82625,7 +82196,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &550
+ items: &547
allOf:
- type: object
required:
@@ -82717,7 +82288,7 @@ paths:
address.
examples:
- true
- roles: &549
+ roles: &546
type: array
description: The roles assigned to the user.
items:
@@ -82776,7 +82347,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *548
+ meta: *545
startIndex:
type: integer
description: A starting index for the returned page
@@ -82815,11 +82386,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *536
- '401': *537
- '403': *538
- '429': *539
- '500': *540
+ '400': *533
+ '401': *534
+ '403': *535
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -82848,7 +82419,7 @@ paths:
required: true
content:
application/json:
- schema: &553
+ schema: &550
type: object
required:
- schemas
@@ -82941,9 +82512,9 @@ paths:
description: Whether this email address is the primary address.
examples:
- true
- roles: *549
+ roles: *546
examples:
- user: &554
+ user: &551
summary: User
value:
schemas:
@@ -82990,9 +82561,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *550
+ schema: *547
examples:
- user: &551
+ user: &548
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -83018,13 +82589,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: *551
- '400': *536
- '401': *537
- '403': *538
- '409': *545
- '429': *539
- '500': *540
+ enterpriseOwner: *548
+ '400': *533
+ '401': *534
+ '403': *535
+ '409': *542
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -83045,7 +82616,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:
- - &552
+ - &549
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -83058,15 +82629,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *550
+ schema: *547
examples:
- default: *551
- '400': *536
- '401': *537
- '403': *538
+ default: *548
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '429': *539
- '500': *540
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -83091,30 +82662,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:
- - *552
+ - *549
- *63
requestBody:
required: true
content:
application/json:
- schema: *553
+ schema: *550
examples:
- user: *554
+ user: *551
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *550
+ schema: *547
examples:
- user: *551
- '400': *536
- '401': *537
- '403': *538
+ user: *548
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '409': *545
- '429': *539
- '500': *540
+ '409': *542
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -83152,13 +82723,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:
- - *552
+ - *549
- *63
requestBody:
required: true
content:
application/json:
- schema: *555
+ schema: *552
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -83198,18 +82769,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *550
- examples:
- userMultiValuedProperties: *551
- userSingleValuedProperties: *551
- disableUser: *551
- '400': *536
- '401': *537
- '403': *538
+ schema: *547
+ examples:
+ userMultiValuedProperties: *548
+ userSingleValuedProperties: *548
+ disableUser: *548
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '409': *545
- '429': *539
- '500': *540
+ '409': *542
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -83229,17 +82800,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:
- - *552
+ - *549
- *63
responses:
'204':
description: User was deleted, no content
- '400': *536
- '401': *537
- '403': *538
+ '400': *533
+ '401': *534
+ '403': *535
'404': *24
- '429': *539
- '500': *540
+ '429': *536
+ '500': *537
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -83367,7 +82938,7 @@ paths:
examples:
- 73..77
- 77..78
- text_matches: &556
+ text_matches: &553
title: Search Result Text Matches
type: array
items:
@@ -83531,7 +83102,7 @@ paths:
enum:
- author-date
- committer-date
- - &557
+ - &554
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
@@ -83600,7 +83171,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *346
+ - *343
comment_count:
type: integer
message:
@@ -83619,7 +83190,7 @@ paths:
url:
type: string
format: uri
- verification: *439
+ verification: *436
required:
- author
- committer
@@ -83634,7 +83205,7 @@ paths:
committer:
anyOf:
- type: 'null'
- - *346
+ - *343
parents:
type: array
items:
@@ -83651,7 +83222,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *556
+ text_matches: *553
required:
- sha
- node_id
@@ -83844,7 +83415,7 @@ paths:
- interactions
- created
- updated
- - *557
+ - *554
- *4
- *5
- name: advanced_search
@@ -83941,11 +83512,11 @@ paths:
type:
- string
- 'null'
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
type: string
state_reason:
@@ -83973,7 +83544,7 @@ paths:
- string
- 'null'
format: date-time
- text_matches: *556
+ text_matches: *553
pull_request:
type: object
properties:
@@ -84022,7 +83593,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *561
+ type: *558
performed_via_github_app:
anyOf:
- type: 'null'
@@ -84196,7 +83767,7 @@ paths:
enum:
- created
- updated
- - *557
+ - *554
- *4
- *5
responses:
@@ -84241,7 +83812,7 @@ paths:
- 'null'
score:
type: number
- text_matches: *556
+ text_matches: *553
required:
- id
- node_id
@@ -84327,7 +83898,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *557
+ - *554
- *4
- *5
responses:
@@ -84564,7 +84135,7 @@ paths:
- admin
- pull
- push
- text_matches: *556
+ text_matches: *553
temp_clone_token:
type: string
allow_merge_commit:
@@ -84873,7 +84444,7 @@ paths:
- string
- 'null'
format: uri
- text_matches: *556
+ text_matches: *553
related:
type:
- array
@@ -85068,7 +84639,7 @@ paths:
- followers
- repositories
- joined
- - *557
+ - *554
- *4
- *5
responses:
@@ -85178,7 +84749,7 @@ paths:
type:
- boolean
- 'null'
- text_matches: *556
+ text_matches: *553
blog:
type:
- string
@@ -85376,7 +84947,7 @@ paths:
description: Response
content:
application/json:
- schema: &562
+ schema: &559
type: object
properties:
status:
@@ -85396,7 +84967,7 @@ paths:
- name
- number
examples:
- default: &563
+ default: &560
value:
status: scheduled
scheduled_time: Tuesday, January 22 at 15:34 -0800
@@ -85441,9 +85012,9 @@ paths:
description: Response
content:
application/json:
- schema: *562
+ schema: *559
examples:
- default: *563
+ default: *560
'401':
description: Unauthorized
requestBody:
@@ -86036,7 +85607,7 @@ paths:
application/json:
schema:
type: array
- items: &564
+ items: &561
type: object
properties:
key:
@@ -86044,7 +85615,7 @@ paths:
pretty-print:
type: string
examples:
- default: &565
+ default: &562
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
@@ -86087,9 +85658,9 @@ paths:
application/json:
schema:
type: array
- items: *564
+ items: *561
examples:
- default: *565
+ default: *562
'401':
description: Unauthorized
requestBody:
@@ -86141,9 +85712,9 @@ paths:
application/json:
schema:
type: array
- items: *564
+ items: *561
examples:
- default: *565
+ default: *562
'401':
description: Unauthorized
requestBody:
@@ -86474,7 +86045,7 @@ paths:
type: array
items: *277
examples:
- default: *566
+ default: *563
headers:
Link: *6
x-github:
@@ -86626,7 +86197,7 @@ paths:
application/json:
schema: *277
examples:
- default: *567
+ default: *564
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86664,218 +86235,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
- - *279
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *280
- examples:
- default: *568
- 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
- - *279
- 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: *280
- examples:
- default: *281
- 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
- - *279
- - *282
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *280
- examples:
- default: *281
- 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
- - *279
- - *282
- 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: *280
- examples:
- default: *569
- 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
- - *279
- - *282
- 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)
@@ -87063,9 +86422,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *284
examples:
- response-if-user-is-a-team-maintainer: *570
+ response-if-user-is-a-team-maintainer: *565
'404': *24
x-github:
githubCloudOnly: false
@@ -87124,9 +86483,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *284
examples:
- response-if-users-membership-with-team-is-now-pending: *571
+ response-if-users-membership-with-team-is-now-pending: *566
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -87199,9 +86558,9 @@ paths:
application/json:
schema:
type: array
- items: *288
+ items: *285
examples:
- default: *572
+ default: *567
headers:
Link: *6
'404': *24
@@ -87228,15 +86587,15 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- *7
- - *289
+ - *286
responses:
'200':
description: Response
content:
application/json:
- schema: *288
+ schema: *285
examples:
- default: *573
+ default: *568
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -87261,7 +86620,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- *7
- - *289
+ - *286
requestBody:
required: false
content:
@@ -87330,7 +86689,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- *7
- - *289
+ - *286
responses:
'204':
description: Response
@@ -87400,14 +86759,14 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- *7
- - *290
- - *291
+ - *287
+ - *288
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *574
+ schema: *569
examples:
alternative-response-with-extra-repository-information:
value:
@@ -87559,8 +86918,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- *7
- - *290
- - *291
+ - *287
+ - *288
requestBody:
required: false
content:
@@ -87611,8 +86970,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- *7
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -87647,9 +87006,9 @@ paths:
application/json:
schema:
type: array
- items: *292
+ items: *289
examples:
- response-if-child-teams-exist: *575
+ response-if-child-teams-exist: *570
headers:
Link: *6
'404': *24
@@ -87682,7 +87041,7 @@ paths:
application/json:
schema:
oneOf:
- - &577
+ - &572
title: Private User
description: Private User
type: object
@@ -87932,7 +87291,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *576
+ - *571
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -88090,7 +87449,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *572
examples:
default:
value:
@@ -88168,7 +87527,7 @@ paths:
type: array
items: *214
examples:
- default: &587
+ default: &582
value:
- id: 197
name: hello_docker
@@ -88255,7 +87614,7 @@ paths:
application/json:
schema:
type: array
- items: &578
+ items: &573
title: Email
description: Email
type: object
@@ -88285,7 +87644,7 @@ paths:
- verified
- visibility
examples:
- default: &589
+ default: &584
value:
- email: octocat@github.com
verified: true
@@ -88362,7 +87721,7 @@ paths:
application/json:
schema:
type: array
- items: *578
+ items: *573
examples:
default:
value:
@@ -88620,7 +87979,7 @@ paths:
application/json:
schema:
type: array
- items: &579
+ items: &574
title: GPG Key
description: A unique encryption key
type: object
@@ -88765,7 +88124,7 @@ paths:
- subkeys
- revoked
examples:
- default: &599
+ default: &594
value:
- id: 3
name: Octocat's GPG Key
@@ -88850,9 +88209,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *574
examples:
- default: &580
+ default: &575
value:
id: 3
name: Octocat's GPG Key
@@ -88909,7 +88268,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:
- - &581
+ - &576
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -88921,9 +88280,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *574
examples:
- default: *580
+ default: *575
'404': *24
'304': *40
'403': *41
@@ -88946,7 +88305,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:
- - *581
+ - *576
responses:
'204':
description: Response
@@ -89137,7 +88496,7 @@ paths:
type: array
items: *82
examples:
- default: *582
+ default: *577
headers:
Link: *6
'404': *24
@@ -89313,7 +88672,7 @@ paths:
application/json:
schema:
type: array
- items: &583
+ items: &578
title: Key
description: Key
type: object
@@ -89416,9 +88775,9 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *578
examples:
- default: &584
+ default: &579
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -89451,15 +88810,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:
- - *472
+ - *469
responses:
'200':
description: Response
content:
application/json:
- schema: *583
+ schema: *578
examples:
- default: *584
+ default: *579
'404': *24
'304': *40
'403': *41
@@ -89482,7 +88841,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:
- - *472
+ - *469
responses:
'204':
description: Response
@@ -90311,7 +89670,7 @@ paths:
type: array
items: *68
examples:
- default: *585
+ default: *580
headers:
Link: *6
'304': *40
@@ -90353,7 +89712,7 @@ paths:
- docker
- nuget
- container
- - *586
+ - *581
- *5
- *4
responses:
@@ -90365,8 +89724,8 @@ paths:
type: array
items: *214
examples:
- default: *587
- '400': *588
+ default: *582
+ '400': *583
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90395,7 +89754,7 @@ paths:
application/json:
schema: *214
examples:
- default: &600
+ default: &595
value:
id: 40201
name: octo-name
@@ -90848,9 +90207,9 @@ paths:
application/json:
schema:
type: array
- items: *578
+ items: *573
examples:
- default: *589
+ default: *584
headers:
Link: *6
'304': *40
@@ -90963,7 +90322,7 @@ paths:
type: array
items: *82
examples:
- default: &596
+ default: &591
summary: Default response
value:
- id: 1296269
@@ -91281,9 +90640,9 @@ paths:
description: Response
content:
application/json:
- schema: *301
+ schema: *298
examples:
- default: *303
+ default: *300
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -91321,9 +90680,9 @@ paths:
application/json:
schema:
type: array
- items: *446
+ items: *443
examples:
- default: *590
+ default: *585
headers:
Link: *6
'304': *40
@@ -91346,7 +90705,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *447
+ - *444
responses:
'204':
description: Response
@@ -91369,7 +90728,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *447
+ - *444
responses:
'204':
description: Response
@@ -91402,7 +90761,7 @@ paths:
application/json:
schema:
type: array
- items: &591
+ items: &586
title: Social account
description: Social media account
type: object
@@ -91419,7 +90778,7 @@ paths:
- provider
- url
examples:
- default: &592
+ default: &587
value:
- provider: twitter
url: https://twitter.com/github
@@ -91482,9 +90841,9 @@ paths:
application/json:
schema:
type: array
- items: *591
+ items: *586
examples:
- default: *592
+ default: *587
'422': *33
'304': *40
'404': *24
@@ -91572,7 +90931,7 @@ paths:
application/json:
schema:
type: array
- items: &593
+ items: &588
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -91592,7 +90951,7 @@ paths:
- title
- created_at
examples:
- default: &601
+ default: &596
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -91657,9 +91016,9 @@ paths:
description: Response
content:
application/json:
- schema: *593
+ schema: *588
examples:
- default: &594
+ default: &589
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -91689,7 +91048,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:
- - &595
+ - &590
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -91701,9 +91060,9 @@ paths:
description: Response
content:
application/json:
- schema: *593
+ schema: *588
examples:
- default: *594
+ default: *589
'404': *24
'304': *40
'403': *41
@@ -91726,7 +91085,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:
- - *595
+ - *590
responses:
'204':
description: Response
@@ -91755,7 +91114,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:
- - &602
+ - &597
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
@@ -91780,11 +91139,11 @@ paths:
type: array
items: *82
examples:
- default-response: *596
+ default-response: *591
application/vnd.github.v3.star+json:
schema:
type: array
- items: &603
+ items: &598
title: Starred Repository
description: Starred Repository
type: object
@@ -91940,8 +91299,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response if this repository is starred by you
@@ -91969,8 +91328,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -91994,8 +91353,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:
- - *290
- - *291
+ - *287
+ - *288
responses:
'204':
description: Response
@@ -92154,10 +91513,10 @@ paths:
application/json:
schema:
oneOf:
- - *577
- - *576
+ - *572
+ - *571
examples:
- default-response: &597
+ default-response: &592
summary: Default response
value:
login: octocat
@@ -92192,7 +91551,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &598
+ response-with-git-hub-plan-information: &593
summary: Response with GitHub plan information
value:
login: octocat
@@ -92304,11 +91663,11 @@ paths:
application/json:
schema:
oneOf:
- - *577
- - *576
+ - *572
+ - *571
examples:
- default-response: *597
- response-with-git-hub-plan-information: *598
+ default-response: *592
+ response-with-git-hub-plan-information: *593
'404': *24
x-github:
githubCloudOnly: false
@@ -92339,7 +91698,7 @@ paths:
type: array
items: *214
examples:
- default: *587
+ default: *582
'403': *41
'401': *39
x-github:
@@ -92752,9 +92111,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *574
examples:
- default: *599
+ default: *594
headers:
Link: *6
x-github:
@@ -92858,7 +92217,7 @@ paths:
application/json:
schema: *37
examples:
- default: *445
+ default: *442
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -92944,7 +92303,7 @@ paths:
type: array
items: *68
examples:
- default: *585
+ default: *580
headers:
Link: *6
x-github:
@@ -92983,7 +92342,7 @@ paths:
- docker
- nuget
- container
- - *586
+ - *581
- *8
- *5
- *4
@@ -92996,10 +92355,10 @@ paths:
type: array
items: *214
examples:
- default: *587
+ default: *582
'403': *41
'401': *39
- '400': *588
+ '400': *583
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -93029,7 +92388,7 @@ paths:
application/json:
schema: *214
examples:
- default: *600
+ default: *595
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -93658,9 +93017,9 @@ paths:
application/json:
schema:
type: array
- items: *591
+ items: *586
examples:
- default: *592
+ default: *587
headers:
Link: *6
x-github:
@@ -93690,9 +93049,9 @@ paths:
application/json:
schema:
type: array
- items: *593
+ items: *588
examples:
- default: *601
+ default: *596
headers:
Link: *6
x-github:
@@ -93717,7 +93076,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *8
- - *602
+ - *597
- *9
- *4
- *5
@@ -93729,11 +93088,11 @@ paths:
schema:
anyOf:
- type: array
- items: *603
+ items: *598
- type: array
items: *82
examples:
- default-response: *596
+ default-response: *591
headers:
Link: *6
x-github:
@@ -93945,7 +93304,7 @@ webhooks:
type: string
enum:
- disabled
- enterprise: &604
+ enterprise: &599
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -94014,7 +93373,7 @@ webhooks:
- created_at
- updated_at
- avatar_url
- installation: &605
+ installation: &600
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -94035,7 +93394,7 @@ webhooks:
required:
- id
- node_id
- organization: &606
+ organization: &601
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -94108,7 +93467,7 @@ webhooks:
- public_members_url
- avatar_url
- description
- repository: &607
+ repository: &602
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
@@ -95021,10 +94380,10 @@ webhooks:
type: string
enum:
- enabled
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -95110,11 +94469,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- rule: &608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ rule: &603
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)
@@ -95331,11 +94690,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- rule: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ rule: *603
sender: *17
required:
- action
@@ -95513,11 +94872,11 @@ webhooks:
- everyone
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- rule: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ rule: *603
sender: *17
required:
- action
@@ -95598,11 +94957,11 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- exemption_request: &609
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ exemption_request: &604
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -95876,7 +95235,7 @@ webhooks:
- array
- 'null'
description: The responses to the exemption request.
- items: &610
+ items: &605
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -95996,11 +95355,11 @@ webhooks:
type: string
enum:
- completed
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- exemption_request: *609
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ exemption_request: *604
sender: *17
required:
- action
@@ -96080,11 +95439,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- exemption_request: *609
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ exemption_request: *604
sender: *17
required:
- action
@@ -96164,12 +95523,12 @@ webhooks:
type: string
enum:
- response_dismissed
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- exemption_request: *609
- exemption_response: *610
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ exemption_request: *604
+ exemption_response: *605
sender: *17
required:
- action
@@ -96251,12 +95610,12 @@ webhooks:
type: string
enum:
- response_submitted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- exemption_request: *609
- exemption_response: *610
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ exemption_request: *604
+ exemption_response: *605
sender: *17
required:
- action
@@ -96341,12 +95700,12 @@ webhooks:
type: string
cache_location:
type: string
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
ref:
type: string
- repository: *607
+ repository: *602
sender: *17
required:
- cache_location
@@ -96440,7 +95799,7 @@ webhooks:
type: string
enum:
- completed
- check_run: &612
+ check_run: &607
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -96505,7 +95864,7 @@ webhooks:
- MDEwOkNoZWNrU3VpdGU1
pull_requests:
type: array
- items: *359
+ items: *356
repository: *152
status:
type: string
@@ -96550,7 +95909,7 @@ webhooks:
-
examples:
- neutral
- deployment: *611
+ deployment: *606
details_url:
type: string
examples:
@@ -96610,7 +95969,7 @@ webhooks:
- annotations_url
pull_requests:
type: array
- items: *359
+ items: *356
started_at:
type: string
format: date-time
@@ -96648,10 +96007,10 @@ webhooks:
- output
- app
- pull_requests
- installation: *605
- enterprise: *604
- organization: *606
- repository: *607
+ installation: *600
+ enterprise: *599
+ organization: *601
+ repository: *602
sender: *17
required:
- check_run
@@ -97054,11 +96413,11 @@ webhooks:
type: string
enum:
- created
- check_run: *612
- installation: *605
- enterprise: *604
- organization: *606
- repository: *607
+ check_run: *607
+ installation: *600
+ enterprise: *599
+ organization: *601
+ repository: *602
sender: *17
required:
- check_run
@@ -97464,11 +96823,11 @@ webhooks:
type: string
enum:
- requested_action
- check_run: *612
- installation: *605
- enterprise: *604
- organization: *606
- repository: *607
+ check_run: *607
+ installation: *600
+ enterprise: *599
+ organization: *601
+ repository: *602
requested_action:
description: The action requested by the user.
type: object
@@ -97883,11 +97242,11 @@ webhooks:
type: string
enum:
- rerequested
- check_run: *612
- installation: *605
- enterprise: *604
- organization: *606
- repository: *607
+ check_run: *607
+ installation: *600
+ enterprise: *599
+ organization: *601
+ repository: *602
sender: *17
required:
- check_run
@@ -98889,10 +98248,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -99611,10 +98970,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -100327,10 +99686,10 @@ webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -100509,7 +99868,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -100661,20 +100020,20 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &613
+ commit_oid: &608
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: *604
- installation: *605
- organization: *606
- ref: &614
+ enterprise: *599
+ installation: *600
+ organization: *601
+ ref: &609
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: *607
+ repository: *602
sender: *17
required:
- action
@@ -100851,7 +100210,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -101092,12 +100451,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *613
- enterprise: *604
- installation: *605
- organization: *606
- ref: *614
- repository: *607
+ commit_oid: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ ref: *609
+ repository: *602
sender: *17
required:
- action
@@ -101205,7 +100564,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -101390,12 +100749,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *613
- enterprise: *604
- installation: *605
- organization: *606
- ref: *614
- repository: *607
+ commit_oid: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ ref: *609
+ repository: *602
sender: *17
required:
- action
@@ -101574,7 +100933,7 @@ webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: The reason for dismissing or closing the alert.
type:
@@ -101751,12 +101110,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *613
- enterprise: *604
- installation: *605
- organization: *606
- ref: *614
- repository: *607
+ commit_oid: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ ref: *609
+ repository: *602
sender: *17
required:
- action
@@ -101867,7 +101226,7 @@ webhooks:
type:
- object
- 'null'
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -102056,9 +101415,9 @@ webhooks:
type:
- string
- 'null'
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
@@ -102066,7 +101425,7 @@ webhooks:
type:
- string
- 'null'
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -102175,7 +101534,7 @@ webhooks:
dismissed_by:
type:
- 'null'
- dismissed_comment: *371
+ dismissed_comment: *368
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -102322,12 +101681,12 @@ webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *613
- enterprise: *604
- installation: *605
- organization: *606
- ref: *614
- repository: *607
+ commit_oid: *608
+ enterprise: *599
+ installation: *600
+ organization: *601
+ ref: *609
+ repository: *602
sender: *17
required:
- action
@@ -102599,10 +101958,10 @@ webhooks:
- updated_at
- author_association
- body
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -102693,18 +102052,18 @@ webhooks:
type:
- string
- 'null'
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *606
- pusher_type: &615
+ organization: *601
+ pusher_type: &610
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &616
+ ref: &611
description: The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference)
resource.
type: string
@@ -102714,7 +102073,7 @@ webhooks:
enum:
- tag
- branch
- repository: *607
+ repository: *602
sender: *17
required:
- ref
@@ -102797,9 +102156,9 @@ webhooks:
enum:
- created
definition: *234
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
sender: *17
required:
- action
@@ -102884,9 +102243,9 @@ webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
sender: *17
required:
- action
@@ -102964,9 +102323,9 @@ webhooks:
enum:
- updated
definition: *234
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
sender: *17
required:
- action
@@ -103043,10 +102402,10 @@ webhooks:
type: string
enum:
- updated
- enterprise: *604
- installation: *605
- repository: *607
- organization: *606
+ enterprise: *599
+ installation: *600
+ repository: *602
+ organization: *601
sender: *17
new_property_values:
type: array
@@ -103141,18 +102500,18 @@ webhooks:
title: delete event
type: object
properties:
- enterprise: *604
- installation: *605
- organization: *606
- pusher_type: *615
- ref: *616
+ enterprise: *599
+ installation: *600
+ organization: *601
+ pusher_type: *610
+ ref: *611
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *607
+ repository: *602
sender: *17
required:
- ref
@@ -103246,11 +102605,11 @@ webhooks:
type: string
enum:
- auto_dismissed
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103344,11 +102703,11 @@ webhooks:
type: string
enum:
- auto_reopened
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103442,11 +102801,11 @@ webhooks:
type: string
enum:
- created
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103538,11 +102897,11 @@ webhooks:
type: string
enum:
- dismissed
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103634,11 +102993,11 @@ webhooks:
type: string
enum:
- fixed
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103731,11 +103090,11 @@ webhooks:
type: string
enum:
- reintroduced
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103827,11 +103186,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *408
- installation: *605
- organization: *606
- enterprise: *604
- repository: *607
+ alert: *405
+ installation: *600
+ organization: *601
+ enterprise: *599
+ repository: *602
sender: *17
required:
- action
@@ -103918,9 +103277,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- key: &617
+ enterprise: *599
+ installation: *600
+ key: &612
description: The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -103956,8 +103315,8 @@ webhooks:
- verified
- created_at
- read_only
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -104044,11 +103403,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- key: *617
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ key: *612
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -104630,12 +103989,12 @@ webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- workflow: &621
+ workflow: &616
title: Workflow
type:
- object
@@ -105383,13 +104742,13 @@ webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *414
+ deployment: *411
pull_requests:
type: array
items: *111
- repository: *607
- organization: *606
- installation: *605
+ repository: *602
+ organization: *601
+ installation: *600
sender: *17
responses:
'200':
@@ -105470,7 +104829,7 @@ webhooks:
type: string
enum:
- approved
- approver: &618
+ approver: &613
type: object
properties:
avatar_url:
@@ -105513,11 +104872,11 @@ webhooks:
type: string
comment:
type: string
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- reviewers: &619
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ reviewers: &614
type: array
items:
type: object
@@ -105598,7 +104957,7 @@ webhooks:
sender: *17
since:
type: string
- workflow_job_run: &620
+ workflow_job_run: &615
type: object
properties:
conclusion:
@@ -106354,18 +105713,18 @@ webhooks:
type: string
enum:
- rejected
- approver: *618
+ approver: *613
comment:
type: string
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- reviewers: *619
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ reviewers: *614
sender: *17
since:
type: string
- workflow_job_run: *620
+ workflow_job_run: *615
workflow_job_runs:
type: array
items:
@@ -107092,13 +106451,13 @@ webhooks:
type: string
enum:
- requested
- enterprise: *604
+ enterprise: *599
environment:
type: string
- installation: *605
- organization: *606
- repository: *607
- requestor: &626
+ installation: *600
+ organization: *601
+ repository: *602
+ requestor: &621
title: User
type:
- object
@@ -109051,12 +108410,12 @@ webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- workflow: *621
+ workflow: *616
workflow_run:
title: Deployment Workflow Run
type:
@@ -109757,7 +109116,7 @@ webhooks:
type: string
enum:
- answered
- answer: &624
+ answer: &619
type: object
properties:
author_association:
@@ -109917,7 +109276,7 @@ webhooks:
- created_at
- updated_at
- body
- discussion: &622
+ discussion: &617
title: Discussion
description: A Discussion in a repository.
type: object
@@ -110234,10 +109593,10 @@ webhooks:
- updated_at
- active_lock_reason
- body
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -110374,11 +109733,11 @@ webhooks:
- from
required:
- category
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -110471,11 +109830,11 @@ webhooks:
type: string
enum:
- closed
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -110567,7 +109926,7 @@ webhooks:
type: string
enum:
- created
- comment: &623
+ comment: &618
type: object
properties:
author_association:
@@ -110727,11 +110086,11 @@ webhooks:
- updated_at
- body
- reactions
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -110824,12 +110183,12 @@ webhooks:
type: string
enum:
- deleted
- comment: *623
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ comment: *618
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -110934,12 +110293,12 @@ webhooks:
- from
required:
- body
- comment: *623
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ comment: *618
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111033,11 +110392,11 @@ webhooks:
type: string
enum:
- created
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111129,11 +110488,11 @@ webhooks:
type: string
enum:
- deleted
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111243,11 +110602,11 @@ webhooks:
type: string
required:
- from
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111339,10 +110698,10 @@ webhooks:
type: string
enum:
- labeled
- discussion: *622
- enterprise: *604
- installation: *605
- label: &625
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ label: &620
title: Label
type: object
properties:
@@ -111375,8 +110734,8 @@ webhooks:
- color
- default
- description
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111469,11 +110828,11 @@ webhooks:
type: string
enum:
- locked
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111565,11 +110924,11 @@ webhooks:
type: string
enum:
- pinned
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111661,11 +111020,11 @@ webhooks:
type: string
enum:
- reopened
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111760,16 +111119,16 @@ webhooks:
changes:
type: object
properties:
- new_discussion: *622
- new_repository: *607
+ new_discussion: *617
+ new_repository: *602
required:
- new_discussion
- new_repository
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111862,10 +111221,10 @@ webhooks:
type: string
enum:
- unanswered
- discussion: *622
- old_answer: *624
- organization: *606
- repository: *607
+ discussion: *617
+ old_answer: *619
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -111957,12 +111316,12 @@ webhooks:
type: string
enum:
- unlabeled
- discussion: *622
- enterprise: *604
- installation: *605
- label: *625
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -112055,11 +111414,11 @@ webhooks:
type: string
enum:
- unlocked
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -112151,11 +111510,11 @@ webhooks:
type: string
enum:
- unpinned
- discussion: *622
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ discussion: *617
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -112396,7 +111755,7 @@ webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *604
+ enterprise: *599
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository)
resource.
@@ -113074,9 +112433,9 @@ webhooks:
type: integer
watchers_count:
type: integer
- installation: *605
- organization: *606
- repository: *607
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- forkee
@@ -113242,9 +112601,9 @@ webhooks:
title: gollum event
type: object
properties:
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pages:
description: The pages that were updated.
type: array
@@ -113282,7 +112641,7 @@ webhooks:
- action
- sha
- html_url
- repository: *607
+ repository: *602
sender: *17
required:
- pages
@@ -113368,10 +112727,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories: &627
+ organization: *601
+ repositories: &622
description: An array of repository objects that the installation
can access.
type: array
@@ -113397,8 +112756,8 @@ webhooks:
- name
- full_name
- private
- repository: *607
- requester: *626
+ repository: *602
+ requester: *621
sender: *17
required:
- action
@@ -113483,11 +112842,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories: *627
- repository: *607
+ organization: *601
+ repositories: *622
+ repository: *602
requester:
type:
- 'null'
@@ -113574,11 +112933,11 @@ webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories: *627
- repository: *607
+ organization: *601
+ repositories: *622
+ repository: *602
requester:
type:
- 'null'
@@ -113665,10 +113024,10 @@ webhooks:
type: string
enum:
- added
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories_added: &628
+ organization: *601
+ repositories_added: &623
description: An array of repository objects, which were added to
the installation.
type: array
@@ -113714,15 +113073,15 @@ webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *607
- repository_selection: &629
+ repository: *602
+ repository_selection: &624
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *626
+ requester: *621
sender: *17
required:
- action
@@ -113811,10 +113170,10 @@ webhooks:
type: string
enum:
- removed
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories_added: *628
+ organization: *601
+ repositories_added: *623
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -113841,9 +113200,9 @@ webhooks:
- name
- full_name
- private
- repository: *607
- repository_selection: *629
- requester: *626
+ repository: *602
+ repository_selection: *624
+ requester: *621
sender: *17
required:
- action
@@ -113932,11 +113291,11 @@ webhooks:
type: string
enum:
- suspend
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories: *627
- repository: *607
+ organization: *601
+ repositories: *622
+ repository: *602
requester:
type:
- 'null'
@@ -114129,10 +113488,10 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
target_type:
type: string
@@ -114221,11 +113580,11 @@ webhooks:
type: string
enum:
- unsuspend
- enterprise: *604
+ enterprise: *599
installation: *37
- organization: *606
- repositories: *627
- repository: *607
+ organization: *601
+ repositories: *622
+ repository: *602
requester:
type:
- 'null'
@@ -114483,8 +113842,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -115301,8 +114660,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -115319,7 +114678,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -115663,8 +115022,8 @@ webhooks:
- state
- locked
- assignee
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -115754,7 +115113,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &630
+ comment: &625
title: issue comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment)
itself.
@@ -115921,8 +115280,8 @@ webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -116735,8 +116094,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -116753,7 +116112,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -117099,8 +116458,8 @@ webhooks:
- state
- locked
- assignee
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -117190,7 +116549,7 @@ webhooks:
type: string
enum:
- edited
- changes: &651
+ changes: &646
description: The changes to the comment.
type: object
properties:
@@ -117202,9 +116561,9 @@ webhooks:
type: string
required:
- from
- comment: *630
- enterprise: *604
- installation: *605
+ comment: *625
+ enterprise: *599
+ installation: *600
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -118020,8 +117379,8 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -118038,7 +117397,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -118382,8 +117741,8 @@ webhooks:
- state
- locked
- assignee
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -118475,10 +117834,10 @@ webhooks:
type: string
enum:
- assigned
- assignee: *626
- enterprise: *604
- installation: *605
- issue: &633
+ assignee: *621
+ enterprise: *599
+ installation: *600
+ issue: &628
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -119290,11 +118649,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -119311,7 +118670,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -119414,8 +118773,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -119505,8 +118864,8 @@ webhooks:
type: string
enum:
- closed
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -120323,11 +119682,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -120344,7 +119703,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -120590,8 +119949,8 @@ webhooks:
required:
- state
- closed_at
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -120680,8 +120039,8 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -121489,11 +120848,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -121510,7 +120869,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -121612,8 +120971,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -121702,8 +121061,8 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -122534,11 +121893,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -122555,7 +121914,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -122636,7 +121995,7 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: &631
+ milestone: &626
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -122779,8 +122138,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -122889,8 +122248,8 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -123702,11 +123061,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -123720,7 +123079,7 @@ webhooks:
timeline_url:
type: string
format: uri
- type: *561
+ type: *558
title:
description: Title of the issue
type: string
@@ -123826,9 +123185,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *625
- organization: *606
- repository: *607
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -123918,8 +123277,8 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -124730,11 +124089,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -124748,7 +124107,7 @@ webhooks:
timeline_url:
type: string
format: uri
- type: *561
+ type: *558
title:
description: Title of the issue
type: string
@@ -124854,9 +124213,9 @@ webhooks:
- active_lock_reason
- body
- reactions
- label: *625
- organization: *606
- repository: *607
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -124946,8 +124305,8 @@ webhooks:
type: string
enum:
- locked
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -125783,11 +125142,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -125801,7 +125160,7 @@ webhooks:
timeline_url:
type: string
format: uri
- type: *561
+ type: *558
title:
description: Title of the issue
type: string
@@ -125884,8 +125243,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -125974,8 +125333,8 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -126805,11 +126164,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126826,7 +126185,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -126906,9 +126265,9 @@ webhooks:
format: uri
user_view_type:
type: string
- milestone: *631
- organization: *606
- repository: *607
+ milestone: *626
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -127810,11 +127169,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127910,7 +127269,7 @@ webhooks:
required:
- login
- id
- type: *561
+ type: *558
required:
- id
- number
@@ -128391,8 +127750,8 @@ webhooks:
required:
- old_issue
- old_repository
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -129204,11 +128563,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129225,7 +128584,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -129327,8 +128686,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -129418,9 +128777,9 @@ webhooks:
type: string
enum:
- pinned
- enterprise: *604
- installation: *605
- issue: &632
+ enterprise: *599
+ installation: *600
+ issue: &627
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -130226,11 +129585,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130247,7 +129606,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -130349,8 +129708,8 @@ webhooks:
- active_lock_reason
- body
- reactions
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -130439,8 +129798,8 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -131274,11 +130633,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131375,9 +130734,9 @@ webhooks:
format: uri
user_view_type:
type: string
- type: *561
- organization: *606
- repository: *607
+ type: *558
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -132276,11 +131635,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132297,7 +131656,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -132879,11 +132238,11 @@ webhooks:
required:
- new_issue
- new_repository
- enterprise: *604
- installation: *605
- issue: *632
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ issue: *627
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -132974,7 +132333,7 @@ webhooks:
type: string
enum:
- unassigned
- assignee: &654
+ assignee: &649
title: User
type:
- object
@@ -133046,11 +132405,11 @@ webhooks:
required:
- login
- id
- enterprise: *604
- installation: *605
- issue: *633
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ issue: *628
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -133139,12 +132498,12 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *604
- installation: *605
- issue: *633
- label: *625
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ issue: *628
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -133234,8 +132593,8 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -134069,11 +133428,11 @@ webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *558
- issue_dependencies_summary: *559
+ sub_issues_summary: *555
+ issue_dependencies_summary: *556
issue_field_values:
type: array
- items: *560
+ items: *557
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134090,7 +133449,7 @@ webhooks:
title:
description: Title of the issue
type: string
- type: *561
+ type: *558
updated_at:
type: string
format: date-time
@@ -134170,8 +133529,8 @@ webhooks:
format: uri
user_view_type:
type: string
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134261,11 +133620,11 @@ webhooks:
type: string
enum:
- unpinned
- enterprise: *604
- installation: *605
- issue: *632
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ issue: *627
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134354,11 +133713,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- label: *625
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134446,11 +133805,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- label: *625
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134570,11 +133929,11 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- label: *625
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ label: *620
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134688,11 +134047,11 @@ webhooks:
type: string
required:
- to
- enterprise: *604
- installation: *605
- member: *626
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ member: *621
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134804,11 +134163,11 @@ webhooks:
type:
- string
- 'null'
- enterprise: *604
- installation: *605
- member: *626
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ member: *621
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134897,11 +134256,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *604
- installation: *605
- member: *626
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ member: *621
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -134989,11 +134348,11 @@ webhooks:
type: string
enum:
- added
- enterprise: *604
- installation: *605
- member: *626
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ member: *621
+ organization: *601
+ repository: *602
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -135071,7 +134430,7 @@ webhooks:
required:
- login
- id
- team: &634
+ team: &629
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -135311,11 +134670,11 @@ webhooks:
type: string
enum:
- removed
- enterprise: *604
- installation: *605
- member: *626
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ member: *621
+ organization: *601
+ repository: *602
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -135394,7 +134753,7 @@ webhooks:
required:
- login
- id
- team: *634
+ team: *629
required:
- action
- scope
@@ -135482,7 +134841,7 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
+ enterprise: *599
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -135591,12 +134950,12 @@ webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *605
- organization: *606
+ installation: *600
+ organization: *601
repository:
anyOf:
- type: 'null'
- - *607
+ - *602
sender: *17
required:
- action
@@ -135686,11 +135045,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *604
- installation: *605
- milestone: *631
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ milestone: *626
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -135779,9 +135138,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- milestone: &635
+ enterprise: *599
+ installation: *600
+ milestone: &630
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -135923,8 +135282,8 @@ webhooks:
- updated_at
- due_on
- closed_at
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136013,11 +135372,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- milestone: *631
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ milestone: *626
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136137,11 +135496,11 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- milestone: *631
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ milestone: *626
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136231,11 +135590,11 @@ webhooks:
type: string
enum:
- opened
- enterprise: *604
- installation: *605
- milestone: *635
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ milestone: *630
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136324,9 +135683,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- membership: &636
+ enterprise: *599
+ installation: *600
+ membership: &631
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -136436,8 +135795,8 @@ webhooks:
- role
- organization_url
- user
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136525,11 +135884,11 @@ webhooks:
type: string
enum:
- member_added
- enterprise: *604
- installation: *605
- membership: *636
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ membership: *631
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136618,8 +135977,8 @@ webhooks:
type: string
enum:
- member_invited
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -136741,10 +136100,10 @@ webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
- user: *626
+ user: *621
required:
- action
- invitation
@@ -136832,11 +136191,11 @@ webhooks:
type: string
enum:
- member_removed
- enterprise: *604
- installation: *605
- membership: *636
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ membership: *631
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -136933,11 +136292,11 @@ webhooks:
properties:
from:
type: string
- enterprise: *604
- installation: *605
- membership: *636
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ membership: *631
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -137023,9 +136382,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
package:
description: Information about the package.
type: object
@@ -137548,7 +136907,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: &637
+ items: &632
title: Ruby Gems metadata
type: object
properties:
@@ -137645,7 +137004,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -137731,9 +137090,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
package:
description: Information about the package.
type: object
@@ -138095,7 +137454,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *637
+ items: *632
source_url:
type: string
format: uri
@@ -138166,7 +137525,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -138357,12 +137716,12 @@ webhooks:
- duration
- created_at
- updated_at
- enterprise: *604
+ enterprise: *599
id:
type: integer
- installation: *605
- organization: *606
- repository: *607
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- id
@@ -138439,7 +137798,7 @@ webhooks:
type: string
enum:
- approved
- personal_access_token_request: &638
+ personal_access_token_request: &633
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -138589,10 +137948,10 @@ webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *604
- organization: *606
+ enterprise: *599
+ organization: *601
sender: *17
- installation: *605
+ installation: *600
required:
- action
- personal_access_token_request
@@ -138669,11 +138028,11 @@ webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *638
- enterprise: *604
- organization: *606
+ personal_access_token_request: *633
+ enterprise: *599
+ organization: *601
sender: *17
- installation: *605
+ installation: *600
required:
- action
- personal_access_token_request
@@ -138749,11 +138108,11 @@ webhooks:
type: string
enum:
- created
- personal_access_token_request: *638
- enterprise: *604
- organization: *606
+ personal_access_token_request: *633
+ enterprise: *599
+ organization: *601
sender: *17
- installation: *605
+ installation: *600
required:
- action
- personal_access_token_request
@@ -138828,11 +138187,11 @@ webhooks:
type: string
enum:
- denied
- personal_access_token_request: *638
- organization: *606
- enterprise: *604
+ personal_access_token_request: *633
+ organization: *601
+ enterprise: *599
sender: *17
- installation: *605
+ installation: *600
required:
- action
- personal_access_token_request
@@ -138947,7 +138306,7 @@ webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *639
+ last_response: *634
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -138979,8 +138338,8 @@ webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
zen:
description: Random string of GitHub zen.
@@ -139235,10 +138594,10 @@ webhooks:
- from
required:
- note
- enterprise: *604
- installation: *605
- organization: *606
- project_card: &640
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_card: &635
title: Project Card
type: object
properties:
@@ -139361,7 +138720,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -139452,11 +138811,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- project_card: *640
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_card: *635
+ repository: *602
sender: *17
required:
- action
@@ -139546,9 +138905,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
project_card:
title: Project Card
type: object
@@ -139678,7 +139037,7 @@ webhooks:
repository:
anyOf:
- type: 'null'
- - *607
+ - *602
sender: *17
required:
- action
@@ -139782,11 +139141,11 @@ webhooks:
- from
required:
- note
- enterprise: *604
- installation: *605
- organization: *606
- project_card: *640
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_card: *635
+ repository: *602
sender: *17
required:
- action
@@ -139890,9 +139249,9 @@ webhooks:
- from
required:
- column_id
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
project_card:
allOf:
- title: Project Card
@@ -140089,7 +139448,7 @@ webhooks:
type: string
required:
- after_id
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -140179,10 +139538,10 @@ webhooks:
type: string
enum:
- closed
- enterprise: *604
- installation: *605
- organization: *606
- project: &642
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project: &637
title: Project
type: object
properties:
@@ -140309,7 +139668,7 @@ webhooks:
- creator
- created_at
- updated_at
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -140399,10 +139758,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- project_column: &641
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_column: &636
title: Project Column
type: object
properties:
@@ -140442,7 +139801,7 @@ webhooks:
- name
- created_at
- updated_at
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -140531,14 +139890,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- project_column: *641
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_column: *636
repository:
anyOf:
- type: 'null'
- - *607
+ - *602
sender: *17
required:
- action
@@ -140637,11 +139996,11 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
- project_column: *641
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_column: *636
+ repository: *602
sender: *17
required:
- action
@@ -140731,11 +140090,11 @@ webhooks:
type: string
enum:
- moved
- enterprise: *604
- installation: *605
- organization: *606
- project_column: *641
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project_column: *636
+ repository: *602
sender: *17
required:
- action
@@ -140825,11 +140184,11 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- project: *642
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project: *637
+ repository: *602
sender: *17
required:
- action
@@ -140919,14 +140278,14 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- project: *642
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project: *637
repository:
anyOf:
- type: 'null'
- - *607
+ - *602
sender: *17
required:
- action
@@ -141037,11 +140396,11 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
- project: *642
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project: *637
+ repository: *602
sender: *17
required:
- action
@@ -141130,11 +140489,11 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *604
- installation: *605
- organization: *606
- project: *642
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ project: *637
+ repository: *602
sender: *17
required:
- action
@@ -141225,9 +140584,9 @@ webhooks:
type: string
enum:
- closed
- installation: *605
- organization: *606
- projects_v2: &643
+ installation: *600
+ organization: *601
+ projects_v2: &638
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -141474,9 +140833,9 @@ webhooks:
type: string
enum:
- created
- installation: *605
- organization: *606
- projects_v2: *643
+ installation: *600
+ organization: *601
+ projects_v2: *638
sender: *17
required:
- action
@@ -141567,9 +140926,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *605
- organization: *606
- projects_v2: *643
+ installation: *600
+ organization: *601
+ projects_v2: *638
sender: *17
required:
- action
@@ -141700,9 +141059,9 @@ webhooks:
type: string
to:
type: string
- installation: *605
- organization: *606
- projects_v2: *643
+ installation: *600
+ organization: *601
+ projects_v2: *638
sender: *17
required:
- action
@@ -141795,7 +141154,7 @@ webhooks:
type: string
enum:
- archived
- changes: &647
+ changes: &642
type: object
properties:
archived_at:
@@ -141811,9 +141170,9 @@ webhooks:
- string
- 'null'
format: date-time
- installation: *605
- organization: *606
- projects_v2_item: &644
+ installation: *600
+ organization: *601
+ projects_v2_item: &639
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -141970,9 +141329,9 @@ webhooks:
- 'null'
to:
type: string
- installation: *605
- organization: *606
- projects_v2_item: *644
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142064,9 +141423,9 @@ webhooks:
type: string
enum:
- created
- installation: *605
- organization: *606
- projects_v2_item: *644
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142157,9 +141516,9 @@ webhooks:
type: string
enum:
- deleted
- installation: *605
- organization: *606
- projects_v2_item: *644
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142274,7 +141633,7 @@ webhooks:
oneOf:
- type: string
- type: integer
- - &645
+ - &640
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -142298,7 +141657,7 @@ webhooks:
required:
- id
- name
- - &646
+ - &641
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -142338,8 +141697,8 @@ webhooks:
oneOf:
- type: string
- type: integer
- - *645
- - *646
+ - *640
+ - *641
type:
- 'null'
- string
@@ -142362,9 +141721,9 @@ webhooks:
- 'null'
required:
- body
- installation: *605
- organization: *606
- projects_v2_item: *644
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142471,9 +141830,9 @@ webhooks:
type:
- string
- 'null'
- installation: *605
- organization: *606
- projects_v2_item: *644
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142566,10 +141925,10 @@ webhooks:
type: string
enum:
- restored
- changes: *647
- installation: *605
- organization: *606
- projects_v2_item: *644
+ changes: *642
+ installation: *600
+ organization: *601
+ projects_v2_item: *639
sender: *17
required:
- action
@@ -142661,9 +142020,9 @@ webhooks:
type: string
enum:
- reopened
- installation: *605
- organization: *606
- projects_v2: *643
+ installation: *600
+ organization: *601
+ projects_v2: *638
sender: *17
required:
- action
@@ -142744,10 +142103,10 @@ webhooks:
title: public event
type: object
properties:
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- repository
@@ -142834,13 +142193,13 @@ webhooks:
type: string
enum:
- assigned
- assignee: *626
- enterprise: *604
- installation: *605
- number: &648
+ assignee: *621
+ enterprise: *599
+ installation: *600
+ number: &643
description: The pull request number.
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -145189,7 +144548,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -145281,11 +144640,11 @@ webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -147627,7 +146986,7 @@ webhooks:
- draft
reason:
type: string
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -147719,11 +147078,11 @@ webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -150065,7 +149424,7 @@ webhooks:
- draft
reason:
type: string
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -150157,11 +149516,11 @@ webhooks:
type: string
enum:
- closed
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: &649
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: &644
allOf:
- *111
- type: object
@@ -150225,7 +149584,7 @@ webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -150316,12 +149675,12 @@ webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: *649
- repository: *607
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: *644
+ repository: *602
sender: *17
required:
- action
@@ -150411,11 +149770,11 @@ webhooks:
type: string
enum:
- demilestoned
- enterprise: *604
+ enterprise: *599
milestone: *109
- number: *648
- organization: *606
- pull_request: &650
+ number: *643
+ organization: *601
+ pull_request: &645
title: Pull Request
type: object
properties:
@@ -152742,7 +152101,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -152874,12 +152233,12 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: *649
- repository: *607
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: *644
+ repository: *602
sender: *17
required:
- action
@@ -152969,11 +152328,11 @@ webhooks:
type: string
enum:
- labeled
- enterprise: *604
- installation: *605
- label: *625
- number: *648
- organization: *606
+ enterprise: *599
+ installation: *600
+ label: *620
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -155321,7 +154680,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -155412,10 +154771,10 @@ webhooks:
type: string
enum:
- locked
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -157761,7 +157120,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -157851,12 +157210,12 @@ webhooks:
type: string
enum:
- milestoned
- enterprise: *604
+ enterprise: *599
milestone: *109
- number: *648
- organization: *606
- pull_request: *650
- repository: *607
+ number: *643
+ organization: *601
+ pull_request: *645
+ repository: *602
sender: *17
required:
- action
@@ -157945,12 +157304,12 @@ webhooks:
type: string
enum:
- opened
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: *649
- repository: *607
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: *644
+ repository: *602
sender: *17
required:
- action
@@ -158041,12 +157400,12 @@ webhooks:
type: string
enum:
- ready_for_review
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: *649
- repository: *607
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: *644
+ repository: *602
sender: *17
required:
- action
@@ -158136,12 +157495,12 @@ webhooks:
type: string
enum:
- reopened
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
- pull_request: *649
- repository: *607
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
+ pull_request: *644
+ repository: *602
sender: *17
required:
- action
@@ -158526,9 +157885,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
type: object
properties:
@@ -160758,7 +160117,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -160848,7 +160207,7 @@ webhooks:
type: string
enum:
- deleted
- comment: &652
+ comment: &647
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.
@@ -161141,9 +160500,9 @@ webhooks:
- start_side
- side
- reactions
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
type: object
properties:
@@ -163361,7 +162720,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -163451,11 +162810,11 @@ webhooks:
type: string
enum:
- edited
- changes: *651
- comment: *652
- enterprise: *604
- installation: *605
- organization: *606
+ changes: *646
+ comment: *647
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
type: object
properties:
@@ -165676,7 +165035,7 @@ webhooks:
- _links
- author_association
- active_lock_reason
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -165767,9 +165126,9 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
title: Simple Pull Request
type: object
@@ -168002,7 +167361,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *607
+ repository: *602
review:
description: The review that was affected.
type: object
@@ -168263,9 +167622,9 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
title: Simple Pull Request
type: object
@@ -170379,8 +169738,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *607
- review: &653
+ repository: *602
+ review: &648
description: The review that was affected.
type: object
properties:
@@ -170628,12 +169987,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
description: The pull request number.
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -172980,7 +172339,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
requested_reviewer:
title: User
type:
@@ -173066,12 +172425,12 @@ webhooks:
type: string
enum:
- review_request_removed
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
description: The pull request number.
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -175425,7 +174784,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -175630,12 +174989,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
description: The pull request number.
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -177984,7 +177343,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
requested_reviewer:
title: User
type:
@@ -178071,12 +177430,12 @@ webhooks:
type: string
enum:
- review_requested
- enterprise: *604
- installation: *605
+ enterprise: *599
+ installation: *600
number:
description: The pull request number.
type: integer
- organization: *606
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -180416,7 +179775,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -180610,9 +179969,9 @@ webhooks:
type: string
enum:
- submitted
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
title: Simple Pull Request
type: object
@@ -182848,8 +182207,8 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *607
- review: *653
+ repository: *602
+ review: *648
sender: *17
required:
- action
@@ -182939,9 +182298,9 @@ webhooks:
type: string
enum:
- resolved
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
title: Simple Pull Request
type: object
@@ -185072,7 +184431,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *607
+ repository: *602
sender: *17
thread:
type: object
@@ -185479,9 +184838,9 @@ webhooks:
type: string
enum:
- unresolved
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
pull_request:
title: Simple Pull Request
type: object
@@ -187595,7 +186954,7 @@ webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *607
+ repository: *602
sender: *17
thread:
type: object
@@ -188004,10 +187363,10 @@ webhooks:
type: string
before:
type: string
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -190342,7 +189701,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -190434,11 +189793,11 @@ webhooks:
type: string
enum:
- unassigned
- assignee: *654
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
+ assignee: *649
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -192788,7 +192147,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -192877,11 +192236,11 @@ webhooks:
type: string
enum:
- unlabeled
- enterprise: *604
- installation: *605
- label: *625
- number: *648
- organization: *606
+ enterprise: *599
+ installation: *600
+ label: *620
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -195220,7 +194579,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -195311,10 +194670,10 @@ webhooks:
type: string
enum:
- unlocked
- enterprise: *604
- installation: *605
- number: *648
- organization: *606
+ enterprise: *599
+ installation: *600
+ number: *643
+ organization: *601
pull_request:
title: Pull Request
type: object
@@ -197643,7 +197002,7 @@ webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -197856,7 +197215,7 @@ webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *604
+ enterprise: *599
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -197951,8 +197310,8 @@ webhooks:
- url
- author
- committer
- installation: *605
- organization: *606
+ installation: *600
+ organization: *601
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -198550,9 +197909,9 @@ webhooks:
type: string
enum:
- published
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
registry_package:
type: object
properties:
@@ -199029,7 +198388,7 @@ webhooks:
type: string
rubygems_metadata:
type: array
- items: *637
+ items: *632
summary:
type: string
tag_name:
@@ -199085,7 +198444,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -199173,9 +198532,9 @@ webhooks:
type: string
enum:
- updated
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
registry_package:
type: object
properties:
@@ -199487,7 +198846,7 @@ webhooks:
- published_at
rubygems_metadata:
type: array
- items: *637
+ items: *632
summary:
type: string
tag_name:
@@ -199537,7 +198896,7 @@ webhooks:
- owner
- package_version
- registry
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -199624,10 +198983,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- release: &655
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: &650
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -199958,7 +199317,7 @@ webhooks:
- updated_at
- zipball_url
- body
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -200045,11 +199404,11 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- release: *655
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: *650
+ repository: *602
sender: *17
required:
- action
@@ -200176,11 +199535,11 @@ webhooks:
type: boolean
required:
- to
- enterprise: *604
- installation: *605
- organization: *606
- release: *655
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: *650
+ repository: *602
sender: *17
required:
- action
@@ -200268,9 +199627,9 @@ webhooks:
type: string
enum:
- prereleased
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
release:
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
@@ -200606,7 +199965,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -200692,10 +200051,10 @@ webhooks:
type: string
enum:
- published
- enterprise: *604
- installation: *605
- organization: *606
- release: &656
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: &651
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -201028,7 +200387,7 @@ webhooks:
- string
- 'null'
format: uri
- repository: *607
+ repository: *602
sender: *17
required:
- action
@@ -201114,11 +200473,11 @@ webhooks:
type: string
enum:
- released
- enterprise: *604
- installation: *605
- organization: *606
- release: *655
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: *650
+ repository: *602
sender: *17
required:
- action
@@ -201204,11 +200563,11 @@ webhooks:
type: string
enum:
- unpublished
- enterprise: *604
- installation: *605
- organization: *606
- release: *656
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ release: *651
+ repository: *602
sender: *17
required:
- action
@@ -201294,10 +200653,10 @@ webhooks:
type: string
enum:
- anonymous_access_disabled
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201382,10 +200741,10 @@ webhooks:
type: string
enum:
- anonymous_access_enabled
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201470,10 +200829,10 @@ webhooks:
type: string
enum:
- archived
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201560,10 +200919,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201651,10 +201010,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201749,10 +201108,10 @@ webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201877,10 +201236,10 @@ webhooks:
- 'null'
items:
type: string
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -201968,10 +201327,10 @@ webhooks:
type: string
enum:
- privatized
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -202058,10 +201417,10 @@ webhooks:
type: string
enum:
- publicized
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -202165,10 +201524,10 @@ webhooks:
- name
required:
- repository
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -202248,10 +201607,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
repository_ruleset: *261
sender: *17
required:
@@ -202330,10 +201689,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
repository_ruleset: *261
sender: *17
required:
@@ -202412,10 +201771,10 @@ webhooks:
type: string
enum:
- edited
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
repository_ruleset: *261
changes:
type: object
@@ -202477,16 +201836,16 @@ webhooks:
properties:
added:
type: array
- items: *512
+ items: *509
deleted:
type: array
- items: *512
+ items: *509
updated:
type: array
items:
type: object
properties:
- rule: *512
+ rule: *509
changes:
type: object
properties:
@@ -202733,10 +202092,10 @@ webhooks:
- from
required:
- owner
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -202824,10 +202183,10 @@ webhooks:
type: string
enum:
- unarchived
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -202915,7 +202274,7 @@ webhooks:
type: string
enum:
- create
- alert: &657
+ alert: &652
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -203039,10 +202398,10 @@ webhooks:
type: string
enum:
- open
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -203262,10 +202621,10 @@ webhooks:
type: string
enum:
- dismissed
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -203353,11 +202712,11 @@ webhooks:
type: string
enum:
- reopen
- alert: *657
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ alert: *652
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -203569,10 +202928,10 @@ webhooks:
enum:
- fixed
- open
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -203660,7 +203019,7 @@ webhooks:
type: string
enum:
- created
- alert: &658
+ alert: &653
type: object
properties:
number: *91
@@ -203737,10 +203096,10 @@ webhooks:
format: date-time
description: 'The time that push protection was bypassed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -203831,11 +203190,11 @@ webhooks:
type: string
enum:
- created
- alert: *658
- installation: *605
- location: *659
- organization: *606
- repository: *607
+ alert: *653
+ installation: *600
+ location: *654
+ organization: *601
+ repository: *602
sender: *17
required:
- location
@@ -204078,11 +203437,11 @@ webhooks:
type: string
enum:
- reopened
- alert: *658
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ alert: *653
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -204170,11 +203529,11 @@ webhooks:
type: string
enum:
- resolved
- alert: *658
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ alert: *653
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -204262,11 +203621,11 @@ webhooks:
type: string
enum:
- validated
- alert: *658
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ alert: *653
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -204352,11 +203711,11 @@ webhooks:
type: string
enum:
- published
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- security_advisory: &660
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ security_advisory: &655
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -204552,11 +203911,11 @@ webhooks:
type: string
enum:
- updated
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
- security_advisory: *660
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
+ security_advisory: *655
sender: *17
required:
- action
@@ -204639,10 +203998,10 @@ webhooks:
type: string
enum:
- withdrawn
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -204839,10 +204198,10 @@ webhooks:
type: object
properties:
security_and_analysis: *239
- enterprise: *604
- installation: *605
- organization: *606
- repository: *301
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *298
sender: *17
required:
- changes
@@ -204930,12 +204289,12 @@ webhooks:
type: string
enum:
- cancelled
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: &661
+ sponsorship: &656
type: object
properties:
created_at:
@@ -205250,12 +204609,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: *661
+ sponsorship: *656
required:
- action
- sponsorship
@@ -205353,12 +204712,12 @@ webhooks:
type: string
required:
- from
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: *661
+ sponsorship: *656
required:
- action
- changes
@@ -205445,17 +204804,17 @@ webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &662
+ effective_date: &657
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: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: *661
+ sponsorship: *656
required:
- action
- sponsorship
@@ -205539,7 +204898,7 @@ webhooks:
type: string
enum:
- pending_tier_change
- changes: &663
+ changes: &658
type: object
properties:
tier:
@@ -205583,13 +204942,13 @@ webhooks:
- from
required:
- tier
- effective_date: *662
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ effective_date: *657
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: *661
+ sponsorship: *656
required:
- action
- changes
@@ -205676,13 +205035,13 @@ webhooks:
type: string
enum:
- tier_changed
- changes: *663
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ changes: *658
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- sponsorship: *661
+ sponsorship: *656
required:
- action
- changes
@@ -205766,10 +205125,10 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -205863,10 +205222,10 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -206305,15 +205664,15 @@ webhooks:
type:
- string
- 'null'
- enterprise: *604
+ enterprise: *599
id:
description: The unique identifier of the status.
type: integer
- installation: *605
+ installation: *600
name:
type: string
- organization: *606
- repository: *607
+ organization: *601
+ repository: *602
sender: *17
sha:
description: The Commit SHA.
@@ -206426,12 +205785,12 @@ webhooks:
title: team_add event
type: object
properties:
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- team: &664
+ team: &659
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -206671,9 +206030,9 @@ webhooks:
type: string
enum:
- added_to_repository
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
repository:
title: Repository
description: A git repository
@@ -207143,7 +206502,7 @@ webhooks:
- topics
- visibility
sender: *17
- team: *664
+ team: *659
required:
- action
- team
@@ -207229,9 +206588,9 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
repository:
title: Repository
description: A git repository
@@ -207701,7 +207060,7 @@ webhooks:
- topics
- visibility
sender: *17
- team: *664
+ team: *659
required:
- action
- team
@@ -207788,9 +207147,9 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
repository:
title: Repository
description: A git repository
@@ -208260,7 +207619,7 @@ webhooks:
- topics
- visibility
sender: *17
- team: *664
+ team: *659
required:
- action
- team
@@ -208414,9 +207773,9 @@ webhooks:
- from
required:
- permissions
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
repository:
title: Repository
description: A git repository
@@ -208886,7 +208245,7 @@ webhooks:
- topics
- visibility
sender: *17
- team: *664
+ team: *659
required:
- action
- changes
@@ -208974,9 +208333,9 @@ webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *604
- installation: *605
- organization: *606
+ enterprise: *599
+ installation: *600
+ organization: *601
repository:
title: Repository
description: A git repository
@@ -209446,7 +208805,7 @@ webhooks:
- topics
- visibility
sender: *17
- team: *664
+ team: *659
required:
- action
- team
@@ -209529,12 +208888,12 @@ webhooks:
type: string
enum:
- created
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- user: *626
+ user: *621
required:
- action
responses:
@@ -209612,12 +208971,12 @@ webhooks:
type: string
enum:
- deleted
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- user: *626
+ user: *621
required:
- action
responses:
@@ -209698,10 +209057,10 @@ webhooks:
type: string
enum:
- started
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
required:
- action
@@ -209784,17 +209143,17 @@ webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *604
+ enterprise: *599
inputs:
type:
- object
- 'null'
additionalProperties: true
- installation: *605
- organization: *606
+ installation: *600
+ organization: *601
ref:
type: string
- repository: *607
+ repository: *602
sender: *17
workflow:
type: string
@@ -209886,10 +209245,10 @@ webhooks:
type: string
enum:
- completed
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
workflow_job:
allOf:
@@ -210145,7 +209504,7 @@ webhooks:
type: string
required:
- conclusion
- deployment: *414
+ deployment: *411
required:
- action
- repository
@@ -210234,10 +209593,10 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
workflow_job:
allOf:
@@ -210519,7 +209878,7 @@ webhooks:
required:
- status
- steps
- deployment: *414
+ deployment: *411
required:
- action
- repository
@@ -210608,10 +209967,10 @@ webhooks:
type: string
enum:
- queued
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
workflow_job:
type: object
@@ -210757,7 +210116,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *414
+ deployment: *411
required:
- action
- repository
@@ -210846,10 +210205,10 @@ webhooks:
type: string
enum:
- waiting
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
workflow_job:
type: object
@@ -210996,7 +210355,7 @@ webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *414
+ deployment: *411
required:
- action
- repository
@@ -211086,12 +210445,12 @@ webhooks:
type: string
enum:
- completed
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- workflow: *621
+ workflow: *616
workflow_run:
title: Workflow Run
type: object
@@ -212120,12 +211479,12 @@ webhooks:
type: string
enum:
- in_progress
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- workflow: *621
+ workflow: *616
workflow_run:
title: Workflow Run
type: object
@@ -213139,12 +212498,12 @@ webhooks:
type: string
enum:
- requested
- enterprise: *604
- installation: *605
- organization: *606
- repository: *607
+ enterprise: *599
+ installation: *600
+ organization: *601
+ repository: *602
sender: *17
- workflow: *621
+ workflow: *616
workflow_run:
title: Workflow Run
{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}