diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 522a8e51f..6c4f1a0d5 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -29573,449 +29573,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" - }, - "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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, "/orgs/{org}/teams/{team_slug}/invitations": { "get": { "summary": "List pending team invitations", @@ -66279,338 +65836,6 @@ "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", @@ -121455,51 +120680,6 @@ "url" ] }, - "reaction": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -127056,6 +126236,51 @@ "updated_at" ] }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -291196,177 +290421,24 @@ "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 - } - } - ] - }, - "team-discussion": { - "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 - } - } - }, - "team-discussion-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": "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 - } - } - }, - "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", + "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, - "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, @@ -291380,7 +290452,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -291402,19 +290474,24 @@ "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", + "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, - "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, @@ -291427,7 +290504,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -291449,19 +290526,24 @@ "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", + "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", - "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, @@ -291474,12 +290556,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -291499,16 +290579,35 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] }, - "reaction": { + "team-discussion-comment": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -291528,8 +290627,76 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": { @@ -296798,6 +295965,64 @@ "updated_at": "2011-04-14T16:00:49Z" } }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, "commit-items": { "value": [ { @@ -312506,15 +311731,6 @@ "type": "integer" } }, - "reaction-id": { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -312834,6 +312050,15 @@ "$ref": "#/components/schemas/alert-number" } }, + "reaction-id": { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "commit-sha": { "name": "commit_sha", "description": "The SHA of the commit.", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 8dc8cbc48..1b22dc5b8 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -21394,326 +21394,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - 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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -48134,256 +47814,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -89166,43 +88596,6 @@ components: - number - updated_at - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -93534,6 +92927,43 @@ components: - author_association - created_at - updated_at + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -218971,56 +218401,6 @@ components: hooray: 0 eyes: 1 rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -223565,6 +222945,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -237160,13 +236590,6 @@ components: required: true schema: type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -237441,6 +236864,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 522a8e51f..6c4f1a0d5 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -29573,449 +29573,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" - }, - "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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, "/orgs/{org}/teams/{team_slug}/invitations": { "get": { "summary": "List pending team invitations", @@ -66279,338 +65836,6 @@ "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", @@ -121455,51 +120680,6 @@ "url" ] }, - "reaction": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -127056,6 +126236,51 @@ "updated_at" ] }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -291196,177 +290421,24 @@ "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 - } - } - ] - }, - "team-discussion": { - "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 - } - } - }, - "team-discussion-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": "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 - } - } - }, - "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", + "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, - "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, @@ -291380,7 +290452,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -291402,19 +290474,24 @@ "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", + "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, - "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, @@ -291427,7 +290504,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -291449,19 +290526,24 @@ "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", + "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", - "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, @@ -291474,12 +290556,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -291499,16 +290579,35 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] }, - "reaction": { + "team-discussion-comment": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -291528,8 +290627,76 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": { @@ -296798,6 +295965,64 @@ "updated_at": "2011-04-14T16:00:49Z" } }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, "commit-items": { "value": [ { @@ -312506,15 +311731,6 @@ "type": "integer" } }, - "reaction-id": { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -312834,6 +312050,15 @@ "$ref": "#/components/schemas/alert-number" } }, + "reaction-id": { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "commit-sha": { "name": "commit_sha", "description": "The SHA of the commit.", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 8dc8cbc48..1b22dc5b8 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -21394,326 +21394,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - 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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -48134,256 +47814,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -89166,43 +88596,6 @@ components: - number - updated_at - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -93534,6 +92927,43 @@ components: - author_association - created_at - updated_at + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -218971,56 +218401,6 @@ components: hooray: 0 eyes: 1 rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -223565,6 +222945,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -237160,13 +236590,6 @@ components: required: true schema: type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -237441,6 +236864,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 3b585b29c..f88e1a08f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -201227,17 +201227,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/invitations": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -201258,43 +201258,6 @@ "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" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -201322,19 +201285,37 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Organization Invitation", + "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64" }, - "node_id": { + "login": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "nullable": true }, - "user": { + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -201456,36 +201437,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -201494,29 +201473,36 @@ "value": [ { "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "login": "octocat", + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -201536,20 +201522,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/teams/members#list-team-members" }, "parameters": [ { @@ -201571,238 +201559,175 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "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 when the reaction type has already been added to this team discussion comment", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "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": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -201821,239 +201746,144 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } + } + ] } } } + }, + "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" } }, - "201": { + { + "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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { + "url": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "format": "uri" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "nullable": true + "default": "member", + "example": "member", + "type": "string" }, - "content": { - "description": "The reaction to use", - "example": "heart", + "state": { + "description": "The state of the user's membership in the team.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "active", + "pending" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "role", + "state", + "url" ] }, "examples": { - "default": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -202075,57 +201905,177 @@ } }, { - "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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/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": "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": "reaction_id", - "description": "The unique identifier of the reaction.", + "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": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -202146,34 +202096,6 @@ "type": "string" } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -202201,19 +202123,28 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "user": { + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -202335,36 +202266,540 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "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" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "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", - "user", - "content", - "created_at" + "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" ] } }, @@ -202372,9 +202807,11 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -202394,8 +202831,98 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } } ] } @@ -202415,20 +202942,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "teams" } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/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/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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -202450,274 +202979,127 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "Response", + "description": "Alternative response with repository permissions", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { "id": { - "type": "integer", - "example": 1 + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" }, "node_id": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "key": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "mit" }, - "gravatar_id": { + "name": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MIT License" }, "url": { "type": "string", + "nullable": true, "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://api.github.com/licenses/mit" }, - "repos_url": { + "spdx_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "nullable": true, + "example": "MIT" }, - "events_url": { + "node_id": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "MDc6TGljZW5zZW1pdA==" }, - "received_events_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "type": { - "type": "string", - "example": "User" + "pull": { + "type": "boolean" }, - "site_admin": { + "triage": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "push": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "example": "public" + "maintain": { + "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "admin", + "pull", + "push" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { + "role_name": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "admin" }, - "user": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -202842,88 +203224,693 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "created_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "example": false + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "examples": { + "alternative-response-with-repository-permissions": { + "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, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, + "404": { + "description": "Not Found if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + } + } + }, + "examples": { + "default": { + "summary": "Adding a team to an organization repository with the write role", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -202945,21 +203932,21 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -202971,22 +203958,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "teams" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/teams/{team_slug}/teams": { "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`.", + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -203028,230 +204015,252 @@ ], "responses": { "200": { - "description": "Response", + "description": "if child teams exist", "content": { "application/json": { "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string", - "nullable": true + "type": "integer" }, - "email": { - "type": "string", - "nullable": true + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": "string", "nullable": true }, - "failed_reason": { - "type": "string", - "nullable": true + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "pull": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "triage": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - }, - "invitation_teams_url": { - "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" - }, - "invitation_source": { - "type": "string", - "example": "\"member\"" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true } }, "required": [ "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] } }, "examples": { - "default": { + "response-if-child-teams-exist": { "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": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/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 + "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" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "html_url": "https://github.com/orgs/rails/teams/core" } ] } @@ -203272,21 +204281,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "members" + "subcategory": "teams" } } }, - "/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.", + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/list-members-in-org", + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -203299,537 +204308,589 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "security_product", "in": "path", + "description": "The security feature to enable or disable.", "required": true, - "schema": { - "type": "string" - } - }, - { - "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 + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] } }, { - "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", + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "value": null } } } } }, + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "/rate_limit": { "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).", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "teams" + "rate-limit" ], - "operationId": "teams/get-membership-for-user-in-org", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-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" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "role", - "state", - "url" + "rate", + "resources" ] }, "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", + "default": { "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "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" - } + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, + "schema": { + "type": "integer" } }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } - } - }, - "responses": { - "200": { - "description": "Response", + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", + "documentation_url": { "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "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" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/orgs/{org}/teams/{team_slug}/repos": { + "/repos/{owner}/{repo}": { "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list-repos-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "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": { @@ -203837,31 +204898,13 @@ } }, { - "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/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": { @@ -203870,984 +204913,27 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "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" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - }, - "secret_scanning_non_provider_patterns": { - "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/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/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.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "example": "admin" - }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -204970,12 +205056,9 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -205199,11 +205282,11 @@ "example": 80 }, "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { - "description": "The default branch of the repository.", "type": "string", "example": "master" }, @@ -205212,8 +205295,6 @@ "example": 0 }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, "type": "boolean", "example": true }, @@ -205221,23 +205302,23 @@ "type": "array", "items": { "type": "string" - } + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, "type": "boolean", "example": true }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, "type": "boolean", "example": true }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, "type": "boolean", "example": true }, @@ -205245,14 +205326,14 @@ "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { "type": "boolean", "example": true }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { @@ -205261,2022 +205342,192 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "type": "string", + "example": "public" }, "pushed_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "example": "2011-01-26T19:06:43Z" }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "example": "2011-01-26T19:01:12Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false + "example": "2011-01-26T19:14:43Z" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, + "allow_rebase_merge": { "type": "boolean", "example": true }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "example": false - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "examples": { - "alternative-response-with-repository-permissions": { - "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, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - } - } - } - } - }, - "204": { - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." - }, - "404": { - "description": "Not Found if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." - } - } - }, - "examples": { - "default": { - "summary": "Adding a team to an organization repository with the write role", - "value": { - "permission": "push" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-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" - } - }, - { - "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": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-child-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-child-teams" - }, - "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": "if child teams exist", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "html_url": "https://github.com/orgs/rails/teams/core" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/{security_product}/{enablement}": { - "post": { - "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "The security feature to enable or disable.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "query_suite": { - "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", - "type": "string", - "enum": [ - "default", - "extended" - ] - } - } - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "responses": { - "204": { - "description": "Action started" - }, - "422": { - "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "orgs", - "deprecationDate": "2024-07-22", - "removalDate": "2025-07-22" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "remaining": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "reset": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "used": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "graphql": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", @@ -526604,2991 +524855,302 @@ }, "maintain": { "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 40, - "incomplete_results": false, - "items": [ - { - "id": 3081286, - "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", - "name": "Tetris", - "full_name": "dtrupenn/Tetris", - "owner": { - "login": "dtrupenn", - "id": 872147, - "node_id": "MDQ6VXNlcjg3MjE0Nw==", - "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/dtrupenn", - "received_events_url": "https://api.github.com/users/dtrupenn/received_events", - "type": "User", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "site_admin": true - }, - "private": false, - "html_url": "https://github.com/dtrupenn/Tetris", - "description": "A C implementation of Tetris using Pennsim through LC4", - "fork": false, - "url": "https://api.github.com/repos/dtrupenn/Tetris", - "created_at": "2012-01-01T00:31:50Z", - "updated_at": "2013-01-05T17:58:47Z", - "pushed_at": "2012-01-01T00:37:02Z", - "homepage": "https://github.com", - "size": 524, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Assembly", - "forks_count": 0, - "open_issues_count": 0, - "master_branch": "master", - "default_branch": "master", - "score": 1, - "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", - "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", - "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", - "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", - "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", - "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", - "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", - "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", - "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", - "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", - "git_url": "git:github.com/dtrupenn/Tetris.git", - "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", - "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", - "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", - "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", - "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", - "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", - "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", - "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", - "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", - "ssh_url": "git@github.com:dtrupenn/Tetris.git", - "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", - "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", - "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", - "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", - "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", - "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", - "clone_url": "https://github.com/dtrupenn/Tetris.git", - "mirror_url": "git:git.example.com/dtrupenn/Tetris", - "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", - "svn_url": "https://svn.github.com/dtrupenn/Tetris", - "forks": 1, - "open_issues": 1, - "watchers": 1, - "has_issues": true, - "has_projects": true, - "has_pages": true, - "has_wiki": true, - "has_downloads": true, - "archived": true, - "disabled": true, - "visibility": "private", - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - } - } - ] - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/topics": { - "get": { - "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/topics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-topics" - }, - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", - "in": "query", - "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": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "display_name": { - "type": "string", - "nullable": true - }, - "short_description": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true - }, - "released": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" - }, - "repository_count": { - "type": "integer", - "nullable": true - }, - "logo_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "related": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - }, - "aliases": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - } - }, - "required": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", - "created_at", - "updated_at", - "featured", - "curated", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 6, - "incomplete_results": false, - "items": [ - { - "name": "ruby", - "display_name": "Ruby", - "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", - "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", - "created_by": "Yukihiro Matsumoto", - "released": "December 21, 1995", - "created_at": "2016-11-28T22:03:59Z", - "updated_at": "2017-10-30T18:16:32Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "rails", - "display_name": "Rails", - "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", - "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", - "created_by": "David Heinemeier Hansson", - "released": "December 13 2005", - "created_at": "2016-12-09T17:03:50Z", - "updated_at": "2017-10-30T16:20:19Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "python", - "display_name": "Python", - "short_description": "Python is a dynamically typed programming language.", - "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", - "created_by": "Guido van Rossum", - "released": "February 20, 1991", - "created_at": "2016-12-07T00:07:02Z", - "updated_at": "2017-10-27T22:45:43Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "jekyll", - "display_name": "Jekyll", - "short_description": "Jekyll is a simple, blog-aware static site generator.", - "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", - "created_by": "Tom Preston-Werner", - "released": "2008", - "created_at": "2016-12-16T21:53:08Z", - "updated_at": "2017-10-27T19:00:24Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "sass", - "display_name": "Sass", - "short_description": "Sass is a stable extension to classic CSS.", - "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", - "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", - "released": "November 28, 2006", - "created_at": "2016-12-16T21:53:45Z", - "updated_at": "2018-01-16T16:30:40Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "homebrew", - "display_name": "Homebrew", - "short_description": "Homebrew is a package manager for macOS.", - "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", - "created_by": "Max Howell", - "released": "2009", - "created_at": "2016-12-17T20:30:44Z", - "updated_at": "2018-02-06T16:14:56Z", - "featured": true, - "curated": true, - "score": 1 - } - ] - } - } - } - } - } - }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/users": { - "get": { - "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", - "tags": [ - "search" - ], - "operationId": "search/users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-users" - }, - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "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/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": "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", - "nullable": true - }, - "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", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "location": { - "type": "string", - "nullable": true - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "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", - "nullable": true - }, - "company": { - "type": "string", - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/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/rest/teams/teams#get-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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/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/rest/teams/teams#update-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team.", - "nullable": true - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "seats": { - "type": "integer" + "required": [ + "admin", + "pull", + "push" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" + "temp_clone_token": { + "type": "string" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "is_template": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + } }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "score" + ] + } } - }, - "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" - } + "total_count": 40, + "incomplete_results": false, + "items": [ + { + "id": 3081286, + "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", + "name": "Tetris", + "full_name": "dtrupenn/Tetris", + "owner": { + "login": "dtrupenn", + "id": 872147, + "node_id": "MDQ6VXNlcjg3MjE0Nw==", + "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/dtrupenn", + "received_events_url": "https://api.github.com/users/dtrupenn/received_events", + "type": "User", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "site_admin": true + }, + "private": false, + "html_url": "https://github.com/dtrupenn/Tetris", + "description": "A C implementation of Tetris using Pennsim through LC4", + "fork": false, + "url": "https://api.github.com/repos/dtrupenn/Tetris", + "created_at": "2012-01-01T00:31:50Z", + "updated_at": "2013-01-05T17:58:47Z", + "pushed_at": "2012-01-01T00:37:02Z", + "homepage": "https://github.com", + "size": 524, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Assembly", + "forks_count": 0, + "open_issues_count": 0, + "master_branch": "master", + "default_branch": "master", + "score": 1, + "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", + "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", + "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", + "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", + "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", + "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", + "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", + "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", + "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", + "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", + "git_url": "git:github.com/dtrupenn/Tetris.git", + "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", + "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", + "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", + "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", + "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", + "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", + "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", + "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", + "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", + "ssh_url": "git@github.com:dtrupenn/Tetris.git", + "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", + "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", + "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", + "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", + "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", + "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", + "clone_url": "https://github.com/dtrupenn/Tetris.git", + "mirror_url": "git:git.example.com/dtrupenn/Tetris", + "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", + "svn_url": "https://svn.github.com/dtrupenn/Tetris", + "forks": 1, + "open_issues": 1, + "watchers": 1, + "has_issues": true, + "has_projects": true, + "has_pages": true, + "has_wiki": true, + "has_downloads": true, + "archived": true, + "disabled": true, + "visibility": "private", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + } + } + ] } } } } } }, - "404": { - "description": "Resource not found", + "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" } } @@ -529665,208 +525227,392 @@ } } }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" } }, "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.", + "category": "search", + "subcategory": "search" + } + } + }, + "/search/topics": { + "get": { + "summary": "Search topics", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/delete-legacy", + "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/rest/search/search#search-topics" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", + "in": "query", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "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" - } - } - } - } + { + "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 } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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": { - "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": "Topic Search Result Item", + "description": "Topic Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "name": { "type": "string" }, - "field": { - "type": "string" + "display_name": { + "type": "string", + "nullable": true }, - "message": { - "type": "string" + "short_description": { + "type": "string", + "nullable": true }, - "code": { - "type": "string" + "description": { + "type": "string", + "nullable": true }, - "index": { - "type": "integer" + "created_by": { + "type": "string", + "nullable": true }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { + "released": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "featured": { + "type": "boolean" + }, + "curated": { + "type": "boolean" + }, + "score": { + "type": "number" + }, + "repository_count": { + "type": "integer", + "nullable": true + }, + "logo_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } - ] + } + }, + "related": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } + }, + "aliases": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } } - } + }, + "required": [ + "name", + "display_name", + "short_description", + "description", + "created_by", + "released", + "created_at", + "updated_at", + "featured", + "curated", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 6, + "incomplete_results": false, + "items": [ + { + "name": "ruby", + "display_name": "Ruby", + "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", + "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", + "created_by": "Yukihiro Matsumoto", + "released": "December 21, 1995", + "created_at": "2016-11-28T22:03:59Z", + "updated_at": "2017-10-30T18:16:32Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "rails", + "display_name": "Rails", + "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", + "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", + "created_by": "David Heinemeier Hansson", + "released": "December 13 2005", + "created_at": "2016-12-09T17:03:50Z", + "updated_at": "2017-10-30T16:20:19Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "python", + "display_name": "Python", + "short_description": "Python is a dynamically typed programming language.", + "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", + "created_by": "Guido van Rossum", + "released": "February 20, 1991", + "created_at": "2016-12-07T00:07:02Z", + "updated_at": "2017-10-27T22:45:43Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "jekyll", + "display_name": "Jekyll", + "short_description": "Jekyll is a simple, blog-aware static site generator.", + "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", + "created_by": "Tom Preston-Werner", + "released": "2008", + "created_at": "2016-12-16T21:53:08Z", + "updated_at": "2017-10-27T19:00:24Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "sass", + "display_name": "Sass", + "short_description": "Sass is a stable extension to classic CSS.", + "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", + "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", + "released": "November 28, 2006", + "created_at": "2016-12-16T21:53:45Z", + "updated_at": "2018-01-16T16:30:40Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "homebrew", + "display_name": "Homebrew", + "short_description": "Homebrew is a package manager for macOS.", + "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", + "created_by": "Max Howell", + "released": "2009", + "created_at": "2016-12-17T20:30:44Z", + "updated_at": "2018-02-06T16:14:56Z", + "featured": true, + "curated": true, + "score": 1 + } + ] + } + } } } } + }, + "304": { + "description": "Not modified" } }, "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": { + "/search/users": { "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.", + "summary": "Search users", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", "tags": [ - "teams" + "search" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/rest/search/search#search-users" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "in": "query", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "direction", - "description": "The direction to sort the results by.", + "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "asc", - "desc" + "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" } @@ -529896,113 +525642,188 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "type": "object", + "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": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { - "type": "string", - "example": "octocat" + "type": "string" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "type": "string" }, "avatar_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri" }, "gravatar_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "format": "uri" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, "followers_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, - "following_url": { + "subscriptions_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri" }, - "gists_url": { + "organizations_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri" }, - "starred_url": { + "repos_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "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": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time" }, - "repos_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "date-time" + }, + "name": { + "type": "string", + "nullable": true }, - "events_url": { + "bio": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "nullable": true }, - "received_events_url": { + "email": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "email", + "nullable": true }, - "type": { + "location": { "type": "string", - "example": "User" + "nullable": true }, "site_admin": { "type": "boolean" }, - "starred_at": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "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", - "example": "\"2020-07-09T00:17:55Z\"" + "nullable": true }, - "user_view_type": { + "company": { "type": "string", - "example": "public" + "nullable": true + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -530023,221 +525844,136 @@ "starred_url", "subscriptions_url", "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "score" ] } - }, - "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", + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "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/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/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", - "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 + "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 } - } - ] + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { "schema": { - "type": "string" + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } @@ -530246,23 +525982,22 @@ "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.", + "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/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/create-discussion-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -530275,406 +526010,616 @@ } } ], - "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": { + "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": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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/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/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/rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -530685,763 +526630,1317 @@ "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", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -531450,20 +527949,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": [ { @@ -531474,20 +527973,106 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -531496,22 +528081,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": [ { @@ -531523,15 +528108,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.", @@ -531573,8 +528149,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": { @@ -531703,57 +528279,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -531810,12 +528410,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -531845,19 +528450,24 @@ "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", + "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, - "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, @@ -531890,20 +528500,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": [ { @@ -531914,15 +528524,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -531932,19 +528533,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." } } } @@ -531957,8 +528569,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": { @@ -532087,57 +528699,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532194,12 +528830,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532227,19 +528868,24 @@ "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", + "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, - "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, @@ -532264,22 +528910,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": [ { @@ -532299,15 +528945,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -532316,8 +528953,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": { @@ -532446,57 +529083,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532553,12 +529214,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532586,19 +529252,24 @@ "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", + "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, - "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, @@ -532622,20 +529293,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": [ { @@ -532655,37 +529326,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" } } } @@ -532698,8 +529361,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": { @@ -532828,57 +529491,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532935,12 +529622,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532968,19 +529660,24 @@ "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", + "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", - "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, @@ -533004,20 +529701,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": [ { @@ -533037,15 +529734,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -533059,22 +529747,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}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", + "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -533096,31 +529784,17 @@ } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -533150,19 +529824,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -533287,33 +529953,122 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] } }, @@ -533321,9 +530076,7 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -533343,8 +530096,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -533364,23 +530138,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -533400,15 +530174,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -533418,29 +530183,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like apples?" } } } @@ -533453,19 +530208,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -533590,41 +530337,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -533644,8 +530478,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -533654,27 +530509,28 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-legacy", + "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -533696,40 +530552,12 @@ } }, { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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", + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -533739,239 +530567,326 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "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": [ - { + "value": { + "author": { + "login": "octocat", "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-legacy", + "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -533991,6 +530906,15 @@ "schema": { "type": "integer" } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -534000,29 +530924,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like pineapples?" } } } @@ -534030,24 +530944,16 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -534172,41 +531078,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -534226,8 +531219,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -534237,11 +531251,66 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "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": [ + { + "name": "team_id", + "description": "The unique identifier of the team.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "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, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index ed8839170..9b6b6b39e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -8795,7 +8795,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &483 + - &481 name: has in: query description: |- @@ -8911,7 +8911,7 @@ paths: - unknown - direct - transitive - security_advisory: &484 + security_advisory: &482 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9173,14 +9173,14 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &485 + auto_dismissed_at: &483 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &486 + dismissal_request: &484 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -11424,7 +11424,7 @@ paths: action: type: string issue: *74 - comment: &533 + comment: &531 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -16110,14 +16110,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &334 + - &330 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &335 + - &331 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16179,7 +16179,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &338 + '301': &334 description: Moved permanently content: application/json: @@ -19486,7 +19486,7 @@ paths: type: integer repository_cache_usages: type: array - items: &345 + items: &341 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20678,7 +20678,7 @@ paths: - all - local_only - selected - selected_actions_url: &351 + selected_actions_url: &347 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -20761,7 +20761,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &351 type: object properties: days: @@ -20803,7 +20803,7 @@ paths: required: true content: application/json: - schema: &356 + schema: &352 type: object properties: days: @@ -20860,7 +20860,7 @@ paths: required: - approval_policy examples: - default: &357 + default: &353 value: approval_policy: first_time_contributors '404': *6 @@ -20919,7 +20919,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &354 type: object required: - run_workflows_from_fork_pull_requests @@ -20973,7 +20973,7 @@ paths: required: true content: application/json: - schema: &359 + schema: &355 type: object required: - run_workflows_from_fork_pull_requests @@ -21608,7 +21608,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &356 type: object properties: default_workflow_permissions: &144 @@ -21659,7 +21659,7 @@ paths: required: false content: application/json: - schema: &361 + schema: &357 type: object properties: default_workflow_permissions: *144 @@ -22790,7 +22790,7 @@ paths: application/json: schema: type: array - items: &362 + items: &358 title: Runner Application description: Runner Application type: object @@ -22815,7 +22815,7 @@ paths: - download_url - filename examples: - default: &363 + default: &359 value: - os: osx architecture: x64 @@ -22901,7 +22901,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &364 + '201': &360 description: Response content: application/json: @@ -23012,7 +23012,7 @@ paths: - token - expires_at examples: - default: &365 + default: &361 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23051,7 +23051,7 @@ paths: application/json: schema: *155 examples: - default: &366 + default: &362 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23085,7 +23085,7 @@ paths: application/json: schema: *153 examples: - default: &367 + default: &363 value: id: 23 name: MBP @@ -23311,7 +23311,7 @@ paths: - *67 - *152 responses: - '200': &368 + '200': &364 description: Response content: application/json: @@ -23368,7 +23368,7 @@ paths: parameters: - *67 - *152 - - &369 + - &365 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23498,7 +23498,7 @@ paths: description: Response content: application/json: - schema: &381 + schema: &377 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23527,7 +23527,7 @@ paths: - key_id - key examples: - default: &382 + default: &378 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23940,7 +23940,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *67 - - &350 + - &346 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)." @@ -25482,7 +25482,7 @@ paths: initiator: type: string examples: - default: &395 + default: &391 value: attestations: - bundle: @@ -26411,7 +26411,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *67 - - &420 + - &416 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`, @@ -26421,7 +26421,7 @@ paths: schema: &176 type: string description: The name of the tool used to generate the code scanning analysis. - - &421 + - &417 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 @@ -26444,7 +26444,7 @@ paths: be returned. in: query required: false - schema: &423 + schema: &419 type: string description: State of a code scanning alert. enum: @@ -26467,7 +26467,7 @@ paths: be returned. in: query required: false - schema: &424 + schema: &420 type: string description: Severity of a code scanning alert. enum: @@ -26501,7 +26501,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: &425 + instances_url: &421 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -26524,7 +26524,7 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: &426 + dismissed_reason: &422 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -26533,13 +26533,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &427 + dismissed_comment: &423 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &428 + rule: &424 type: object properties: id: @@ -26592,7 +26592,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &429 + tool: &425 type: object properties: name: *176 @@ -26602,26 +26602,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *177 - most_recent_instance: &430 + most_recent_instance: &426 type: object properties: - ref: &422 + ref: &418 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &440 + analysis_key: &436 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: &441 + environment: &437 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: &442 + category: &438 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -26635,7 +26635,7 @@ paths: properties: text: type: string - location: &443 + location: &439 type: object description: Describe a region within a file for the alert. properties: @@ -26656,7 +26656,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: &444 + items: &440 type: string description: A classification of the file. For example to identify it as generated. @@ -27945,7 +27945,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &456 + properties: &452 name: type: string description: The name of the machine. @@ -27987,7 +27987,7 @@ paths: - ready - in_progress nullable: true - required: &457 + required: &453 - name - display_name - operating_system @@ -28855,7 +28855,7 @@ paths: - updated_at - visibility examples: - default: &458 + default: &454 value: total_count: 2 secrets: @@ -28893,7 +28893,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &455 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28922,7 +28922,7 @@ paths: - key_id - key examples: - default: &460 + default: &456 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28954,7 +28954,7 @@ paths: application/json: schema: *186 examples: - default: &462 + default: &458 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -30567,7 +30567,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &487 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -30584,7 +30584,7 @@ paths: - key_id - key examples: - default: &490 + default: &488 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32384,7 +32384,7 @@ paths: application/json: schema: *22 examples: - default: &528 + default: &526 value: id: 1 account: @@ -32609,7 +32609,7 @@ paths: required: true content: application/json: - schema: &529 + schema: &527 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -33462,7 +33462,7 @@ paths: application/json: schema: *232 examples: - default: &455 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -37845,7 +37845,7 @@ paths: content: oneOf: - *74 - - &470 + - &468 title: Pull Request Simple description: Pull Request Simple type: object @@ -40860,7 +40860,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &333 title: Full Repository description: Full Repository type: object @@ -41253,7 +41253,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &475 + properties: &473 url: type: string format: uri @@ -41269,7 +41269,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &476 + required: &474 - url - key - name @@ -41358,7 +41358,7 @@ paths: - network_count - subscribers_count examples: - default: &339 + default: &335 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -47702,407 +47702,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - *67 - - *68 - - *325 - - *328 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &329 - title: Reaction - description: Reactions to conversations provide a way to help people - express their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &331 - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - *67 - - *68 - - *325 - - *328 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: *329 - examples: - default: &330 - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - *67 - - *68 - - *325 - - *328 - - &332 - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - *67 - - *68 - - *325 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - *67 - - *68 - - *325 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - *67 - - *68 - - *325 - - *332 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -48215,7 +47814,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &329 title: Team Membership description: Team Membership type: object @@ -48305,7 +47904,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-users-membership-with-team-is-now-pending: &666 summary: Response if user's membership with team is now pending @@ -48414,8 +48013,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Alternative response with repository permissions @@ -48992,8 +48591,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -49040,8 +48639,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -49232,7 +48831,7 @@ paths: resources: type: object properties: - core: &336 + core: &332 title: Rate Limit type: object properties: @@ -49249,21 +48848,21 @@ paths: - remaining - reset - used - graphql: *336 - search: *336 - code_search: *336 - source_import: *336 - integration_manifest: *336 - code_scanning_upload: *336 - actions_runner_registration: *336 - scim: *336 - dependency_snapshots: *336 - dependency_sbom: *336 - code_scanning_autofix: *336 + graphql: *332 + search: *332 + code_search: *332 + source_import: *332 + integration_manifest: *332 + code_scanning_upload: *332 + actions_runner_registration: *332 + scim: *332 + dependency_snapshots: *332 + dependency_sbom: *332 + code_scanning_autofix: *332 required: - core - search - rate: *336 + rate: *332 required: - rate - resources @@ -49368,14 +48967,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *337 + schema: *333 examples: default-response: summary: Default response @@ -49876,7 +49475,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *338 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49894,8 +49493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -50142,10 +49741,10 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 - '307': &340 + default: *335 + '307': &336 description: Temporary Redirect content: application/json: @@ -50174,8 +49773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -50197,7 +49796,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *340 + '307': *336 '404': *6 '409': *51 x-github: @@ -50221,11 +49820,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - - &373 + - &369 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50248,7 +49847,7 @@ paths: type: integer artifacts: type: array - items: &341 + items: &337 title: Artifact description: An artifact type: object @@ -50326,7 +49925,7 @@ paths: - expires_at - updated_at examples: - default: &374 + default: &370 value: total_count: 2 artifacts: @@ -50387,9 +49986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *334 - - *335 - - &342 + - *330 + - *331 + - &338 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50401,7 +50000,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *337 examples: default: value: @@ -50439,9 +50038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *334 - - *335 - - *342 + - *330 + - *331 + - *338 responses: '204': description: Response @@ -50465,9 +50064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *334 - - *335 - - *342 + - *330 + - *331 + - *338 - name: archive_format in: path required: true @@ -50481,7 +50080,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': &532 + '410': &530 description: Gone content: application/json: @@ -50506,14 +50105,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &343 + schema: &339 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -50546,13 +50145,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *343 + schema: *339 examples: selected_actions: *42 responses: @@ -50581,14 +50180,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &344 + schema: &340 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -50621,13 +50220,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *344 + schema: *340 examples: selected_actions: *44 responses: @@ -50658,14 +50257,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *345 + schema: *341 examples: default: value: @@ -50691,11 +50290,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - - &346 + - &342 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 @@ -50729,7 +50328,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &343 title: Repository actions caches description: Repository actions caches type: object @@ -50771,7 +50370,7 @@ paths: - total_count - actions_caches examples: - default: &348 + default: &344 value: total_count: 1 actions_caches: @@ -50803,23 +50402,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: - - *334 - - *335 + - *330 + - *331 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *346 + - *342 responses: '200': description: Response content: application/json: - schema: *347 + schema: *343 examples: - default: *348 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50839,8 +50438,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: - - *334 - - *335 + - *330 + - *331 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50871,9 +50470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *334 - - *335 - - &349 + - *330 + - *331 + - &345 name: job_id description: The unique identifier of the job. in: path @@ -50885,7 +50484,7 @@ paths: description: Response content: application/json: - schema: &377 + schema: &373 title: Job description: Information of a job execution in a workflow run type: object @@ -51192,9 +50791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *334 - - *335 - - *349 + - *330 + - *331 + - *345 responses: '302': description: Response @@ -51222,9 +50821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *334 - - *335 - - *349 + - *330 + - *331 + - *345 requestBody: required: false content: @@ -51269,8 +50868,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Status response @@ -51320,8 +50919,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -51384,8 +50983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -51403,7 +51002,7 @@ paths: type: integer secrets: type: array - items: &379 + items: &375 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51423,7 +51022,7 @@ paths: - created_at - updated_at examples: - default: &380 + default: &376 value: total_count: 2 secrets: @@ -51456,9 +51055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *334 - - *335 - - *350 + - *330 + - *331 + - *346 - *19 responses: '200': @@ -51475,7 +51074,7 @@ paths: type: integer variables: type: array - items: &383 + items: &379 title: Actions Variable type: object properties: @@ -51505,7 +51104,7 @@ paths: - created_at - updated_at examples: - default: &384 + default: &380 value: total_count: 2 variables: @@ -51538,8 +51137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51548,11 +51147,11 @@ paths: schema: type: object properties: - enabled: &352 + enabled: &348 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *136 - selected_actions_url: *351 + selected_actions_url: *347 sha_pinning_required: *137 required: - enabled @@ -51581,8 +51180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51593,7 +51192,7 @@ paths: schema: type: object properties: - enabled: *352 + enabled: *348 allowed_actions: *136 sha_pinning_required: *137 required: @@ -51625,14 +51224,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &353 + schema: &349 type: object properties: access_level: @@ -51649,7 +51248,7 @@ paths: required: - access_level examples: - default: &354 + default: &350 value: access_level: organization x-github: @@ -51673,15 +51272,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *353 + schema: *349 examples: - default: *354 + default: *350 responses: '204': description: Response @@ -51705,14 +51304,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: default: value: @@ -51736,8 +51335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Empty response for successful settings update @@ -51747,7 +51346,7 @@ paths: required: true content: application/json: - schema: *356 + schema: *352 examples: default: summary: Set retention days @@ -51771,8 +51370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51780,7 +51379,7 @@ paths: application/json: schema: *138 examples: - default: *357 + default: *353 '404': *6 x-github: enabledForGitHubApps: true @@ -51799,8 +51398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51834,14 +51433,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *358 + schema: *354 examples: default: *139 '403': *29 @@ -51863,13 +51462,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *359 + schema: *355 examples: default: *139 responses: @@ -51895,8 +51494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51923,8 +51522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51956,14 +51555,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *360 + schema: *356 examples: default: *146 x-github: @@ -51986,8 +51585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Success response @@ -51998,7 +51597,7 @@ paths: required: true content: application/json: - schema: *361 + schema: *357 examples: default: *146 x-github: @@ -52027,8 +51626,8 @@ paths: in: query schema: type: string - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -52072,8 +51671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -52081,9 +51680,9 @@ paths: application/json: schema: type: array - items: *362 + items: *358 examples: - default: *363 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52105,8 +51704,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -52149,7 +51748,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *364 + '201': *360 '404': *6 '422': *7 '409': *51 @@ -52180,8 +51779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -52189,7 +51788,7 @@ paths: application/json: schema: *155 examples: - default: *365 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52217,8 +51816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -52226,7 +51825,7 @@ paths: application/json: schema: *155 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52248,8 +51847,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '200': @@ -52258,7 +51857,7 @@ paths: application/json: schema: *153 examples: - default: *367 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52279,8 +51878,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '204': @@ -52307,8 +51906,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '200': *157 @@ -52333,8 +51932,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: - - *334 - - *335 + - *330 + - *331 - *152 requestBody: required: true @@ -52383,8 +51982,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: - - *334 - - *335 + - *330 + - *331 - *152 requestBody: required: true @@ -52434,11 +52033,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: - '200': *368 + '200': *364 '404': *6 x-github: githubCloudOnly: false @@ -52465,10 +52064,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: - - *334 - - *335 + - *330 + - *331 - *152 - - *369 + - *365 responses: '200': *157 '404': *6 @@ -52496,9 +52095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *334 - - *335 - - &387 + - *330 + - *331 + - &383 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. @@ -52506,7 +52105,7 @@ paths: required: false schema: type: string - - &388 + - &384 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52514,7 +52113,7 @@ paths: required: false schema: type: string - - &389 + - &385 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52523,7 +52122,7 @@ paths: required: false schema: type: string - - &390 + - &386 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 @@ -52550,7 +52149,7 @@ paths: - pending - *17 - *19 - - &391 + - &387 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)." @@ -52559,7 +52158,7 @@ paths: schema: type: string format: date-time - - &370 + - &366 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52568,13 +52167,13 @@ paths: schema: type: boolean default: false - - &392 + - &388 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &393 + - &389 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52597,7 +52196,7 @@ paths: type: integer workflow_runs: type: array - items: &371 + items: &367 title: Workflow Run description: An invocation of a workflow type: object @@ -52745,7 +52344,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &415 + properties: &411 id: type: string description: SHA for the commit @@ -52796,7 +52395,7 @@ paths: - name - email nullable: true - required: &416 + required: &412 - id - tree_id - message @@ -52843,7 +52442,7 @@ paths: - workflow_url - pull_requests examples: - default: &394 + default: &390 value: total_count: 1 workflow_runs: @@ -53079,24 +52678,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *334 - - *335 - - &372 + - *330 + - *331 + - &368 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *370 + - *366 responses: '200': description: Response content: application/json: - schema: *371 + schema: *367 examples: - default: &375 + default: &371 value: id: 30433642 name: Build @@ -53337,9 +52936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '204': description: Response @@ -53362,9 +52961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -53483,9 +53082,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: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '201': description: Response @@ -53518,12 +53117,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 - *17 - *19 - - *373 + - *369 responses: '200': description: Response @@ -53539,9 +53138,9 @@ paths: type: integer artifacts: type: array - items: *341 + items: *337 examples: - default: *374 + default: *370 headers: Link: *58 x-github: @@ -53565,25 +53164,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *334 - - *335 - - *372 - - &376 + - *330 + - *331 + - *368 + - &372 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *370 + - *366 responses: '200': description: Response content: application/json: - schema: *371 + schema: *367 examples: - default: *375 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53606,10 +53205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *334 - - *335 + - *330 + - *331 + - *368 - *372 - - *376 - *17 - *19 responses: @@ -53627,9 +53226,9 @@ paths: type: integer jobs: type: array - items: *377 + items: *373 examples: - default: &378 + default: &374 value: total_count: 1 jobs: @@ -53742,10 +53341,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *334 - - *335 + - *330 + - *331 + - *368 - *372 - - *376 responses: '302': description: Response @@ -53773,9 +53372,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '202': description: Response @@ -53808,9 +53407,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: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: true content: @@ -53877,9 +53476,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '202': description: Response @@ -53912,9 +53511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 - 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 @@ -53944,9 +53543,9 @@ paths: type: integer jobs: type: array - items: *377 + items: *373 examples: - default: *378 + default: *374 headers: Link: *58 x-github: @@ -53971,9 +53570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '302': description: Response @@ -54000,9 +53599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '204': description: Response @@ -54029,9 +53628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -54091,7 +53690,7 @@ paths: items: type: object properties: - type: &498 + type: &496 type: string description: The type of reviewer. enum: @@ -54176,9 +53775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: true content: @@ -54225,7 +53824,7 @@ paths: application/json: schema: type: array - items: &493 + items: &491 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54331,7 +53930,7 @@ paths: - created_at - updated_at examples: - default: &494 + default: &492 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54387,9 +53986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: false content: @@ -54433,9 +54032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: false content: @@ -54488,9 +54087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -54627,8 +54226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -54646,9 +54245,9 @@ paths: type: integer secrets: type: array - items: *379 + items: *375 examples: - default: *380 + default: *376 headers: Link: *58 x-github: @@ -54673,16 +54272,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *381 + schema: *377 examples: - default: *382 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54704,17 +54303,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *379 + schema: *375 examples: - default: &511 + default: &509 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54740,8 +54339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -54799,8 +54398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -54826,9 +54425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *334 - - *335 - - *350 + - *330 + - *331 + - *346 - *19 responses: '200': @@ -54845,9 +54444,9 @@ paths: type: integer variables: type: array - items: *383 + items: *379 examples: - default: *384 + default: *380 headers: Link: *58 x-github: @@ -54870,8 +54469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -54923,17 +54522,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 responses: '200': description: Response content: application/json: - schema: *383 + schema: *379 examples: - default: &512 + default: &510 value: name: USERNAME value: octocat @@ -54959,8 +54558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 requestBody: required: true @@ -55003,8 +54602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 responses: '204': @@ -55030,8 +54629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -55049,7 +54648,7 @@ paths: type: integer workflows: type: array - items: &385 + items: &381 title: Workflow description: A GitHub Actions workflow type: object @@ -55156,9 +54755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *334 - - *335 - - &386 + - *330 + - *331 + - &382 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55173,7 +54772,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *381 examples: default: value: @@ -55206,9 +54805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55233,9 +54832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55286,9 +54885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55315,19 +54914,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *334 - - *335 + - *330 + - *331 + - *382 + - *383 + - *384 + - *385 - *386 + - *17 + - *19 - *387 + - *366 - *388 - *389 - - *390 - - *17 - - *19 - - *391 - - *370 - - *392 - - *393 responses: '200': description: Response @@ -55343,9 +54942,9 @@ paths: type: integer workflow_runs: type: array - items: *371 + items: *367 examples: - default: *394 + default: *390 headers: Link: *58 x-github: @@ -55377,9 +54976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '200': description: Response @@ -55440,8 +55039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *334 - - *335 + - *330 + - *331 - *52 - *17 - *45 @@ -55605,8 +55204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -55643,8 +55242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *334 - - *335 + - *330 + - *331 - name: assignee in: path required: true @@ -55680,8 +55279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -55793,8 +55392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *45 - *46 @@ -55851,7 +55450,7 @@ paths: initiator: type: string examples: - default: *395 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55871,8 +55470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -55880,7 +55479,7 @@ paths: application/json: schema: type: array - items: &396 + items: &392 title: Autolink reference description: An autolink reference. type: object @@ -55934,8 +55533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -55974,9 +55573,9 @@ paths: description: response content: application/json: - schema: *396 + schema: *392 examples: - default: &397 + default: &393 value: id: 1 key_prefix: TICKET- @@ -56007,9 +55606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *334 - - *335 - - &398 + - *330 + - *331 + - &394 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56021,9 +55620,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: *397 + default: *393 '404': *6 x-github: githubCloudOnly: false @@ -56043,9 +55642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *334 - - *335 - - *398 + - *330 + - *331 + - *394 responses: '204': description: Response @@ -56069,8 +55668,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response if Dependabot is enabled @@ -56118,8 +55717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -56140,8 +55739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -56161,8 +55760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *334 - - *335 + - *330 + - *331 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56200,7 +55799,7 @@ paths: - url protected: type: boolean - protection: &400 + protection: &396 title: Branch Protection description: Branch Protection type: object @@ -56242,7 +55841,7 @@ paths: required: - contexts - checks - enforce_admins: &403 + enforce_admins: &399 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56257,7 +55856,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &405 + required_pull_request_reviews: &401 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56333,7 +55932,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &402 + restrictions: &398 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56610,9 +56209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *334 - - *335 - - &401 + - *330 + - *331 + - &397 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). @@ -56626,14 +56225,14 @@ paths: description: Response content: application/json: - schema: &411 + schema: &407 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &466 + commit: &464 title: Commit description: Commit type: object @@ -56667,7 +56266,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &399 + properties: &395 name: type: string example: '"Chris Wanstrath"' @@ -56683,7 +56282,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true message: type: string @@ -56704,7 +56303,7 @@ paths: required: - sha - url - verification: &518 + verification: &516 title: Verification type: object properties: @@ -56774,7 +56373,7 @@ paths: type: integer files: type: array - items: &479 + items: &477 title: Diff Entry description: Diff Entry type: object @@ -56858,7 +56457,7 @@ paths: - self protected: type: boolean - protection: *400 + protection: *396 protection_url: type: string format: uri @@ -56965,7 +56564,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *338 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -56987,15 +56586,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *400 + schema: *396 examples: default: value: @@ -57189,9 +56788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -57446,7 +57045,7 @@ paths: url: type: string format: uri - required_status_checks: &408 + required_status_checks: &404 title: Status Check Policy description: Status Check Policy type: object @@ -57598,7 +57197,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *402 + restrictions: *398 required_conversation_resolution: type: object properties: @@ -57710,9 +57309,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -57737,17 +57336,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: &404 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -57769,17 +57368,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: *404 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57798,9 +57397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -57825,17 +57424,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *405 + schema: *401 examples: - default: &406 + default: &402 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -57931,9 +57530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58031,9 +57630,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *401 examples: - default: *406 + default: *402 '422': *15 x-github: githubCloudOnly: false @@ -58054,9 +57653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58083,17 +57682,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: &407 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58116,17 +57715,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: *407 + default: *403 '404': *6 x-github: githubCloudOnly: false @@ -58146,9 +57745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58173,17 +57772,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *408 + schema: *404 examples: - default: &409 + default: &405 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58209,9 +57808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58263,9 +57862,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *404 examples: - default: *409 + default: *405 '404': *6 '422': *15 x-github: @@ -58287,9 +57886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58313,9 +57912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58349,9 +57948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58418,9 +58017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58484,9 +58083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: content: application/json: @@ -58552,15 +58151,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *402 + schema: *398 examples: default: value: @@ -58651,9 +58250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58676,9 +58275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58688,7 +58287,7 @@ paths: type: array items: *5 examples: - default: &410 + default: &406 value: - id: 1 slug: octoapp @@ -58745,9 +58344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58781,7 +58380,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58802,9 +58401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58838,7 +58437,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58859,9 +58458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58895,7 +58494,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58917,9 +58516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58949,9 +58548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -59010,9 +58609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -59071,9 +58670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: content: application/json: @@ -59132,9 +58731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -59168,9 +58767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59228,9 +58827,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59288,9 +58887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59350,9 +58949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59374,7 +58973,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *407 examples: default: value: @@ -59490,8 +59089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -59770,7 +59369,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &408 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60170,9 +59769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *334 - - *335 - - &413 + - *330 + - *331 + - &409 name: check_run_id description: The unique identifier of the check run. in: path @@ -60184,9 +59783,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *408 examples: - default: &414 + default: &410 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60286,9 +59885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 requestBody: required: true content: @@ -60528,9 +60127,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *408 examples: - default: *414 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60550,9 +60149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 - *17 - *19 responses: @@ -60647,9 +60246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 responses: '201': description: Response @@ -60693,8 +60292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -60716,7 +60315,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &417 + schema: &413 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -60806,8 +60405,8 @@ paths: title: Simple Commit description: A commit. type: object - properties: *415 - required: *416 + properties: *411 + required: *412 latest_check_runs_count: type: integer check_runs_url: @@ -60835,7 +60434,7 @@ paths: - check_runs_url - pull_requests examples: - default: &418 + default: &414 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61126,9 +60725,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61147,8 +60746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -61457,9 +61056,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *334 - - *335 - - &419 + - *330 + - *331 + - &415 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61471,9 +61070,9 @@ paths: description: Response content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61496,17 +61095,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *334 - - *335 - - *419 - - &472 + - *330 + - *331 + - *415 + - &470 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &473 + - &471 name: status description: Returns check runs with the specified `status`. in: query @@ -61545,9 +61144,9 @@ paths: type: integer check_runs: type: array - items: *412 + items: *408 examples: - default: &474 + default: &472 value: total_count: 1 check_runs: @@ -61649,9 +61248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *334 - - *335 - - *419 + - *330 + - *331 + - *415 responses: '201': description: Response @@ -61684,21 +61283,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *334 - - *335 - - *420 - - *421 + - *330 + - *331 + - *416 + - *417 - *19 - *17 - - &438 + - &434 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: *422 - - &439 + schema: *418 + - &435 name: pr description: The number of the pull request for the results you want to list. in: query @@ -61723,13 +61322,13 @@ paths: be returned. in: query required: false - schema: *423 + schema: *419 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *424 + schema: *420 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -61753,7 +61352,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: *425 + instances_url: *421 state: *178 fixed_at: *174 dismissed_by: @@ -61764,11 +61363,11 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: *426 - dismissed_comment: *427 - rule: *428 - tool: *429 - most_recent_instance: *430 + dismissed_reason: *422 + dismissed_comment: *423 + rule: *424 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -61894,7 +61493,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &431 + '403': &427 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -61921,9 +61520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *334 - - *335 - - &432 + - *330 + - *331 + - &428 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -61937,7 +61536,7 @@ paths: description: Response content: application/json: - schema: &433 + schema: &429 type: object properties: number: *169 @@ -61945,7 +61544,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: *425 + instances_url: *421 state: *178 fixed_at: *174 dismissed_by: @@ -61956,8 +61555,8 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: *426 - dismissed_comment: *427 + dismissed_reason: *422 + dismissed_comment: *423 rule: type: object properties: @@ -62011,8 +61610,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *429 - most_recent_instance: *430 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -62111,7 +61710,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62131,9 +61730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: true content: @@ -62148,8 +61747,8 @@ paths: enum: - open - dismissed - dismissed_reason: *426 - dismissed_comment: *427 + dismissed_reason: *422 + dismissed_comment: *423 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62177,7 +61776,7 @@ paths: description: Response content: application/json: - schema: *433 + schema: *429 examples: default: value: @@ -62253,7 +61852,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &437 + '403': &433 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -62280,15 +61879,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 responses: '200': description: Response content: application/json: - schema: &434 + schema: &430 type: object properties: status: @@ -62314,13 +61913,13 @@ paths: - description - started_at examples: - default: &435 + default: &431 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &436 + '400': &432 description: Bad Request content: application/json: @@ -62331,7 +61930,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': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62356,29 +61955,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 responses: '200': description: OK content: application/json: - schema: *434 + schema: *430 examples: - default: *435 + default: *431 '202': description: Accepted content: application/json: - schema: *434 + schema: *430 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *436 + '400': *432 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62410,9 +62009,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: false content: @@ -62457,8 +62056,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *436 - '403': *437 + '400': *432 + '403': *433 '404': *6 '422': description: Unprocessable Entity @@ -62482,13 +62081,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *19 - *17 - - *438 - - *439 + - *434 + - *435 responses: '200': description: Response @@ -62499,10 +62098,10 @@ paths: items: type: object properties: - ref: *422 - analysis_key: *440 - environment: *441 - category: *442 + ref: *418 + analysis_key: *436 + environment: *437 + category: *438 state: type: string description: State of a code scanning alert instance. @@ -62517,7 +62116,7 @@ paths: properties: text: type: string - location: *443 + location: *439 html_url: type: string classifications: @@ -62525,7 +62124,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: *444 + items: *440 examples: default: value: @@ -62564,7 +62163,7 @@ paths: end_column: 50 classifications: - source - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62598,25 +62197,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *334 - - *335 - - *420 - - *421 + - *330 + - *331 + - *416 + - *417 - *19 - *17 - - *439 + - *435 - 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: *422 + schema: *418 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &445 + schema: &441 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -62637,23 +62236,23 @@ paths: application/json: schema: type: array - items: &446 + items: &442 type: object properties: - ref: *422 - commit_sha: &454 + ref: *418 + commit_sha: &450 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: *440 + analysis_key: *436 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *442 + category: *438 error: type: string example: error reading field xyz @@ -62677,8 +62276,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *445 - tool: *429 + sarif_id: *441 + tool: *425 deletable: type: boolean warning: @@ -62739,7 +62338,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62775,8 +62374,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: - - *334 - - *335 + - *330 + - *331 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -62789,7 +62388,7 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: response: summary: application/json response @@ -62843,7 +62442,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *431 + '403': *427 '404': *6 '422': description: Response if analysis could not be processed @@ -62930,8 +62529,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: - - *334 - - *335 + - *330 + - *331 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -62984,7 +62583,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': *437 + '403': *433 '404': *6 '503': *112 x-github: @@ -63006,8 +62605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -63015,7 +62614,7 @@ paths: application/json: schema: type: array - items: &447 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -63126,7 +62725,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': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -63155,8 +62754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: language in: path description: The language of the CodeQL database. @@ -63168,7 +62767,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: default: value: @@ -63200,9 +62799,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': &481 + '302': &479 description: Found - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -63224,8 +62823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *334 - - *335 + - *330 + - *331 - name: language in: path description: The language of the CodeQL database. @@ -63235,7 +62834,7 @@ paths: responses: '204': description: Response - '403': *437 + '403': *433 '404': *6 '503': *112 x-github: @@ -63263,8 +62862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -63273,7 +62872,7 @@ paths: type: object additionalProperties: false properties: - language: &448 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -63353,7 +62952,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &452 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63363,7 +62962,7 @@ paths: description: The ID of the variant analysis. controller_repo: *57 actor: *4 - query_language: *448 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -63410,7 +63009,7 @@ paths: items: type: object properties: - repository: &449 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -63446,7 +63045,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &453 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63478,7 +63077,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &450 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -63492,7 +63091,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: *449 + items: *445 required: - repository_count - repositories @@ -63514,8 +63113,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *450 - over_limit_repos: *450 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -63531,7 +63130,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &451 + value: &447 summary: Default response value: id: 1 @@ -63677,10 +63276,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *451 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *451 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission @@ -63708,8 +63307,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: - - *334 - - *335 + - *330 + - *331 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -63721,9 +63320,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *448 examples: - default: *451 + default: *447 '404': *6 '503': *112 x-github: @@ -63746,7 +63345,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: - - *334 + - *330 - name: repo in: path description: The name of the controller repository. @@ -63781,7 +63380,7 @@ paths: type: object properties: repository: *57 - analysis_status: *453 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -63906,8 +63505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -63992,7 +63591,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -64013,8 +63612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64106,7 +63705,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *437 + '403': *433 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64177,8 +63776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64186,7 +63785,7 @@ paths: schema: type: object properties: - commit_sha: *454 + commit_sha: *450 ref: type: string description: |- @@ -64244,7 +63843,7 @@ paths: schema: type: object properties: - id: *445 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -64258,7 +63857,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': *437 + '403': *433 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -64281,8 +63880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *334 - - *335 + - *330 + - *331 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64328,7 +63927,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': *431 + '403': *427 '404': description: Not Found if the sarif id does not match any upload '503': *112 @@ -64353,8 +63952,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -64435,8 +64034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *334 - - *335 + - *330 + - *331 - 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 @@ -64556,8 +64155,8 @@ paths: parameters: - *17 - *19 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -64871,8 +64470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64937,7 +64536,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -64945,7 +64544,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '400': *14 '401': *25 '403': *29 @@ -64974,8 +64573,8 @@ paths: parameters: - *17 - *19 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -65039,8 +64638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65079,8 +64678,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *456 - required: *457 + properties: *452 + required: *453 examples: default: &676 value: @@ -65122,8 +64721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *334 - - *335 + - *330 + - *331 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65207,8 +64806,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: - - *334 - - *335 + - *330 + - *331 - 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 @@ -65274,8 +64873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -65293,7 +64892,7 @@ paths: type: integer secrets: type: array - items: &461 + items: &457 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65313,7 +64912,7 @@ paths: - created_at - updated_at examples: - default: *458 + default: *454 headers: Link: *58 x-github: @@ -65336,16 +64935,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *459 + schema: *455 examples: - default: *460 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65365,17 +64964,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *461 + schema: *457 examples: - default: *462 + default: *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65395,8 +64994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -65449,8 +65048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -65479,8 +65078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *334 - - *335 + - *330 + - *331 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65522,7 +65121,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &463 + properties: &459 login: type: string example: octocat @@ -65615,7 +65214,7 @@ paths: user_view_type: type: string example: public - required: &464 + required: &460 - avatar_url - events_url - followers_url @@ -65689,8 +65288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '204': @@ -65737,8 +65336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 requestBody: required: false @@ -65765,7 +65364,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &531 + schema: &529 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -65994,8 +65593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '204': @@ -66027,8 +65626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '200': @@ -66049,8 +65648,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *463 - required: *464 + properties: *459 + required: *460 nullable: true required: - permission @@ -66105,8 +65704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -66116,7 +65715,7 @@ paths: application/json: schema: type: array - items: &465 + items: &461 title: Commit Comment description: Commit Comment type: object @@ -66174,7 +65773,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &466 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66233,17 +65832,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': description: Response content: application/json: - schema: *465 + schema: *461 examples: - default: &469 + default: &467 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66300,8 +65899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -66324,7 +65923,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: default: value: @@ -66375,8 +65974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -66398,8 +65997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -66426,9 +66025,74 @@ paths: application/json: schema: type: array - items: *329 + items: &462 + title: Reaction + description: Reactions to conversations provide a way to help people + express their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *331 + default: &533 + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' headers: Link: *58 '404': *6 @@ -66449,8 +66113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -66483,16 +66147,40 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: &463 + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -66514,10 +66202,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - &534 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -66566,8 +66260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *334 - - *335 + - *330 + - *331 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -66623,7 +66317,7 @@ paths: application/json: schema: type: array - items: *466 + items: *464 examples: default: &583 value: @@ -66719,9 +66413,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *334 - - *335 - - &467 + - *330 + - *331 + - &465 name: commit_sha description: The SHA of the commit. in: path @@ -66793,9 +66487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 - *17 - *19 responses: @@ -66805,9 +66499,9 @@ paths: application/json: schema: type: array - items: *465 + items: *461 examples: - default: *468 + default: *466 headers: Link: *58 x-github: @@ -66835,9 +66529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 requestBody: required: true content: @@ -66872,9 +66566,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: - default: *469 + default: *467 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66902,9 +66596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 - *17 - *19 responses: @@ -66914,7 +66608,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: &575 value: @@ -67453,11 +67147,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 - - &471 + - &469 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)" @@ -67472,7 +67166,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: &560 value: @@ -67587,11 +67281,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *334 - - *335 + - *330 + - *331 + - *469 + - *470 - *471 - - *472 - - *473 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67625,9 +67319,9 @@ paths: type: integer check_runs: type: array - items: *412 + items: *408 examples: - default: *474 + default: *472 headers: Link: *58 x-github: @@ -67652,9 +67346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -67662,7 +67356,7 @@ paths: schema: type: integer example: 1 - - *472 + - *470 - *17 - *19 responses: @@ -67680,7 +67374,7 @@ paths: type: integer check_suites: type: array - items: *417 + items: *413 examples: default: value: @@ -67880,9 +67574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - *17 - *19 responses: @@ -68080,9 +67774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - *17 - *19 responses: @@ -68173,7 +67867,7 @@ paths: site_admin: false headers: Link: *58 - '301': *338 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68201,8 +67895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -68231,20 +67925,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *475 - required: *476 + properties: *473 + required: *474 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &477 + properties: &475 url: type: string format: uri html_url: type: string format: uri - required: &478 + required: &476 - url - html_url nullable: true @@ -68258,26 +67952,26 @@ paths: contributing: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true readme: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true issue_template: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true pull_request_template: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true required: - code_of_conduct @@ -68404,8 +68098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 - name: basehead @@ -68448,8 +68142,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *466 - merge_base_commit: *466 + base_commit: *464 + merge_base_commit: *464 status: type: string enum: @@ -68469,10 +68163,10 @@ paths: example: 6 commits: type: array - items: *466 + items: *464 files: type: array - items: *479 + items: *477 required: - url - html_url @@ -68758,8 +68452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -68902,7 +68596,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &480 + response-if-content-is-a-file: &478 summary: Response if content is a file value: type: file @@ -69235,7 +68929,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *480 + response-if-content-is-a-file: *478 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69304,7 +68998,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *481 + '302': *479 '304': *37 x-github: githubCloudOnly: false @@ -69327,8 +69021,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -69421,7 +69115,7 @@ paths: description: Response content: application/json: - schema: &482 + schema: &480 title: File Commit description: File Commit type: object @@ -69573,7 +69267,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *480 examples: example-for-creating-a-file: value: @@ -69627,7 +69321,7 @@ paths: schema: oneOf: - *3 - - &513 + - &511 description: Repository rule violation was detected type: object properties: @@ -69680,8 +69374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -69742,7 +69436,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *480 examples: default: value: @@ -69797,8 +69491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *334 - - *335 + - *330 + - *331 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -69921,8 +69615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *190 - *191 - *192 @@ -69934,7 +69628,7 @@ paths: schema: type: string - *194 - - *483 + - *481 - *195 - *196 - *52 @@ -69955,7 +69649,7 @@ paths: application/json: schema: type: array - items: &487 + items: &485 type: object description: A Dependabot alert. properties: @@ -70001,7 +69695,7 @@ paths: - unknown - direct - transitive - security_advisory: *484 + security_advisory: *482 security_vulnerability: *56 url: *172 html_url: *173 @@ -70032,8 +69726,8 @@ paths: nullable: true maxLength: 280 fixed_at: *174 - auto_dismissed_at: *485 - dismissal_request: *486 + auto_dismissed_at: *483 + dismissal_request: *484 required: - number - state @@ -70263,9 +69957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *334 - - *335 - - &488 + - *330 + - *331 + - &486 name: alert_number in: path description: |- @@ -70280,7 +69974,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *485 examples: default: value: @@ -70393,9 +70087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *334 - - *335 - - *488 + - *330 + - *331 + - *486 requestBody: required: true content: @@ -70440,7 +70134,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *485 examples: default: value: @@ -70569,8 +70263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -70588,7 +70282,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &489 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -70641,16 +70335,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: *490 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70670,15 +70364,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *491 + schema: *489 examples: default: value: @@ -70704,8 +70398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -70758,8 +70452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -70782,8 +70476,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: - - *334 - - *335 + - *330 + - *331 - 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 @@ -70943,8 +70637,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -71183,8 +70877,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -71259,7 +70953,7 @@ paths: - version - url additionalProperties: false - metadata: &492 + metadata: &490 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71292,7 +70986,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *492 + metadata: *490 resolved: type: object description: A collection of resolved package dependencies. @@ -71305,7 +70999,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *492 + metadata: *490 relationship: type: string description: A notation of whether a dependency is requested @@ -71434,8 +71128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *334 - - *335 + - *330 + - *331 - name: sha description: The SHA recorded at creation time. in: query @@ -71475,9 +71169,9 @@ paths: application/json: schema: type: array - items: *493 + items: *491 examples: - default: *494 + default: *492 headers: Link: *58 x-github: @@ -71543,8 +71237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -71625,7 +71319,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: simple-example: summary: Simple example @@ -71698,9 +71392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *334 - - *335 - - &495 + - *330 + - *331 + - &493 name: deployment_id description: deployment_id parameter in: path @@ -71712,7 +71406,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -71777,9 +71471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 responses: '204': description: Response @@ -71801,9 +71495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 - *17 - *19 responses: @@ -71813,7 +71507,7 @@ paths: application/json: schema: type: array - items: &496 + items: &494 title: Deployment Status description: The status of a deployment. type: object @@ -71974,9 +71668,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 requestBody: required: true content: @@ -72051,9 +71745,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *494 examples: - default: &497 + default: &495 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72109,9 +71803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 - name: status_id in: path required: true @@ -72122,9 +71816,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *494 examples: - default: *497 + default: *495 '404': *6 x-github: githubCloudOnly: false @@ -72149,8 +71843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -72207,8 +71901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -72225,7 +71919,7 @@ paths: type: integer environments: type: array - items: &499 + items: &497 title: Environment description: Details of a deployment environment type: object @@ -72277,7 +71971,7 @@ paths: type: type: string example: wait_timer - wait_timer: &501 + wait_timer: &499 type: integer example: 30 description: The amount of time to delay a job after @@ -72314,7 +72008,7 @@ paths: items: type: object properties: - type: *498 + type: *496 reviewer: anyOf: - *4 @@ -72338,7 +72032,7 @@ paths: - id - node_id - type - deployment_branch_policy: &502 + deployment_branch_policy: &500 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -72454,9 +72148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *334 - - *335 - - &500 + - *330 + - *331 + - &498 name: environment_name in: path required: true @@ -72469,9 +72163,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *497 examples: - default: &503 + default: &501 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -72555,9 +72249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: false content: @@ -72566,7 +72260,7 @@ paths: type: object nullable: true properties: - wait_timer: *501 + wait_timer: *499 prevent_self_review: type: boolean example: false @@ -72583,13 +72277,13 @@ paths: items: type: object properties: - type: *498 + type: *496 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *502 + deployment_branch_policy: *500 additionalProperties: false examples: default: @@ -72609,9 +72303,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *497 examples: - default: *503 + default: *501 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -72635,9 +72329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 responses: '204': description: Default response @@ -72662,9 +72356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *17 - *19 responses: @@ -72682,7 +72376,7 @@ paths: example: 2 branch_policies: type: array - items: &504 + items: &502 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -72739,9 +72433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: true content: @@ -72787,9 +72481,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - example-wildcard: &505 + example-wildcard: &503 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -72831,10 +72525,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - &506 + - *330 + - *331 + - *498 + - &504 name: branch_policy_id in: path required: true @@ -72846,9 +72540,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - default: *505 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72867,10 +72561,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - *506 + - *330 + - *331 + - *498 + - *504 requestBody: required: true content: @@ -72898,9 +72592,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - default: *505 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72919,10 +72613,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - *506 + - *330 + - *331 + - *498 + - *504 responses: '204': description: Response @@ -72947,9 +72641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 responses: '200': description: List of deployment protection rules @@ -72965,7 +72659,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &507 + items: &505 title: Deployment protection rule description: Deployment protection rule type: object @@ -72984,7 +72678,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &508 + app: &506 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73083,9 +72777,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: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 requestBody: content: application/json: @@ -73106,9 +72800,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *507 + schema: *505 examples: - default: &509 + default: &507 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73143,9 +72837,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: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 - *19 - *17 responses: @@ -73164,7 +72858,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *508 + items: *506 examples: default: value: @@ -73199,10 +72893,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *334 - - *335 - - *500 - - &510 + - *330 + - *331 + - *498 + - &508 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73214,9 +72908,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *505 examples: - default: *509 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73237,10 +72931,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *500 - - *335 - - *334 - - *510 + - *498 + - *331 + - *330 + - *508 responses: '204': description: Response @@ -73266,9 +72960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *17 - *19 responses: @@ -73286,9 +72980,9 @@ paths: type: integer secrets: type: array - items: *379 + items: *375 examples: - default: *380 + default: *376 headers: Link: *58 x-github: @@ -73313,17 +73007,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 responses: '200': description: Response content: application/json: - schema: *381 + schema: *377 examples: - default: *382 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73345,18 +73039,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 responses: '200': description: Response content: application/json: - schema: *379 + schema: *375 examples: - default: *511 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73378,9 +73072,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 requestBody: required: true @@ -73438,9 +73132,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 responses: '204': @@ -73466,10 +73160,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *334 - - *335 - - *500 - - *350 + - *330 + - *331 + - *498 + - *346 - *19 responses: '200': @@ -73486,9 +73180,9 @@ paths: type: integer variables: type: array - items: *383 + items: *379 examples: - default: *384 + default: *380 headers: Link: *58 x-github: @@ -73511,9 +73205,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: true content: @@ -73565,18 +73259,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *162 responses: '200': description: Response content: application/json: - schema: *383 + schema: *379 examples: - default: *512 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73597,10 +73291,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 - - *500 + - *498 requestBody: required: true content: @@ -73642,10 +73336,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 - - *500 + - *498 responses: '204': description: Response @@ -73667,8 +73361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -73736,8 +73430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *334 - - *335 + - *330 + - *331 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -73896,8 +73590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -73929,9 +73623,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 '400': *14 '422': *15 '403': *29 @@ -73952,8 +73646,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74013,7 +73707,7 @@ paths: schema: oneOf: - *120 - - *513 + - *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74038,8 +73732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *334 - - *335 + - *330 + - *331 - name: file_sha in: path required: true @@ -74138,8 +73832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74248,7 +73942,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &512 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74462,15 +74156,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 responses: '200': description: Response content: application/json: - schema: *514 + schema: *512 examples: default: value: @@ -74526,9 +74220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *334 - - *335 - - &515 + - *330 + - *331 + - &513 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. @@ -74545,7 +74239,7 @@ paths: application/json: schema: type: array - items: &516 + items: &514 title: Git Reference description: Git references within a repository type: object @@ -74620,17 +74314,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 responses: '200': description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: &517 + default: &515 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -74659,8 +74353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74689,9 +74383,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: *517 + default: *515 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -74717,9 +74411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 requestBody: required: true content: @@ -74748,9 +74442,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: *517 + default: *515 '422': *15 '409': *51 x-github: @@ -74768,9 +74462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 responses: '204': description: Response @@ -74825,8 +74519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74893,7 +74587,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &517 title: Git Tag description: Metadata for a Git tag type: object @@ -74944,7 +74638,7 @@ paths: - sha - type - url - verification: *518 + verification: *516 required: - sha - url @@ -74954,7 +74648,7 @@ paths: - tag - message examples: - default: &520 + default: &518 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75027,8 +74721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *334 - - *335 + - *330 + - *331 - name: tag_sha in: path required: true @@ -75039,9 +74733,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *517 examples: - default: *520 + default: *518 '404': *6 '409': *51 x-github: @@ -75065,8 +74759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -75139,7 +74833,7 @@ paths: description: Response content: application/json: - schema: &521 + schema: &519 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75235,8 +74929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *334 - - *335 + - *330 + - *331 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75259,7 +74953,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *519 examples: default-response: summary: Default response @@ -75318,8 +75012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -75329,7 +75023,7 @@ paths: application/json: schema: type: array - items: &522 + items: &520 title: Webhook description: Webhooks for repositories. type: object @@ -75457,8 +75151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -75510,9 +75204,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: &523 + default: &521 value: type: Repository id: 12345678 @@ -75560,17 +75254,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '200': description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: *523 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -75590,8 +75284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 requestBody: required: true @@ -75637,9 +75331,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: *523 + default: *521 '422': *15 '404': *6 x-github: @@ -75660,8 +75354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75686,8 +75380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '200': @@ -75715,8 +75409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *204 requestBody: required: false @@ -75761,8 +75455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *17 - *205 @@ -75794,8 +75488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *16 responses: @@ -75824,8 +75518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *16 responses: @@ -75849,8 +75543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75876,8 +75570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75901,8 +75595,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response if immutable releases are enabled @@ -75948,8 +75642,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '409': *51 @@ -75969,8 +75663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '409': *51 @@ -76027,14 +75721,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &524 + schema: &522 title: Import description: A repository import from an external source. type: object @@ -76133,7 +75827,7 @@ paths: - html_url - authors_url examples: - default: &527 + default: &525 value: vcs: subversion use_lfs: true @@ -76149,7 +75843,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': &525 + '503': &523 description: Unavailable due to service under maintenance. content: application/json: @@ -76178,8 +75872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -76227,7 +75921,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: default: value: @@ -76252,7 +75946,7 @@ paths: type: string '422': *15 '404': *6 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76280,8 +75974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -76330,7 +76024,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: example-1: summary: Example 1 @@ -76378,7 +76072,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': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76401,12 +76095,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76432,8 +76126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *334 - - *335 + - *330 + - *331 - &697 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -76448,7 +76142,7 @@ paths: application/json: schema: type: array - items: &526 + items: &524 title: Porter Author description: Porter Author type: object @@ -76502,7 +76196,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': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76527,8 +76221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *334 - - *335 + - *330 + - *331 - name: author_id in: path required: true @@ -76558,7 +76252,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *524 examples: default: value: @@ -76571,7 +76265,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76595,8 +76289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76637,7 +76331,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76665,8 +76359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -76693,11 +76387,11 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: - default: *527 + default: *525 '422': *15 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76720,8 +76414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76729,8 +76423,8 @@ paths: application/json: schema: *22 examples: - default: *528 - '301': *338 + default: *526 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -76750,8 +76444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76764,7 +76458,7 @@ paths: properties: {} additionalProperties: false examples: - default: &530 + default: &528 value: limit: collaborators_only origin: repository @@ -76789,13 +76483,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *529 + schema: *527 examples: default: summary: Example request body @@ -76809,7 +76503,7 @@ paths: application/json: schema: *222 examples: - default: *530 + default: *528 '409': description: Response x-github: @@ -76831,8 +76525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -76855,8 +76549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -76866,7 +76560,7 @@ paths: application/json: schema: type: array - items: *531 + items: *529 examples: default: &690 value: @@ -76999,8 +76693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *334 - - *335 + - *330 + - *331 - *226 requestBody: required: false @@ -77030,7 +76724,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *529 examples: default: value: @@ -77161,8 +76855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *334 - - *335 + - *330 + - *331 - *226 responses: '204': @@ -77194,8 +76888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *334 - - *335 + - *330 + - *331 - 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 @@ -77416,7 +77110,7 @@ paths: state_reason: completed headers: Link: *58 - '301': *338 + '301': *334 '422': *15 '404': *6 x-github: @@ -77445,8 +77139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -77686,7 +77380,7 @@ paths: '422': *15 '503': *112 '404': *6 - '410': *532 + '410': *530 x-github: triggersNotification: true githubCloudOnly: false @@ -77714,8 +77408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *98 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -77736,7 +77430,7 @@ paths: application/json: schema: type: array - items: *533 + items: *531 examples: default: &540 value: @@ -77796,17 +77490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: &534 + default: &532 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -77860,8 +77554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -77884,9 +77578,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: *534 + default: *532 '422': *15 x-github: githubCloudOnly: false @@ -77904,8 +77598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -77926,8 +77620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -77954,9 +77648,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -77977,8 +77671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -78011,16 +77705,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -78042,10 +77736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - *534 responses: '204': description: Response @@ -78065,8 +77759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -78427,8 +78121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *334 - - *335 + - *330 + - *331 - name: event_id in: path required: true @@ -78631,7 +78325,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *532 + '410': *530 '403': *29 x-github: githubCloudOnly: false @@ -78665,8 +78359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - &539 name: issue_number description: The number that identifies the issue. @@ -78682,9 +78376,9 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '304': *37 x-github: githubCloudOnly: false @@ -78709,8 +78403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -78821,9 +78515,9 @@ paths: '422': *15 '503': *112 '403': *29 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78841,8 +78535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -78887,8 +78581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: content: @@ -78938,8 +78632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: assignee in: path @@ -78980,8 +78674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *81 - *17 @@ -78993,13 +78687,13 @@ paths: application/json: schema: type: array - items: *533 + items: *531 examples: default: *540 headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79028,8 +78722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -79052,16 +78746,16 @@ paths: description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: *534 + default: *532 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -79089,8 +78783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -79106,9 +78800,9 @@ paths: default: *541 headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79136,8 +78830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -79168,9 +78862,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *338 + '301': *334 '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -79201,8 +78895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: issue_id in: path @@ -79218,12 +78912,12 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *532 + '410': *530 x-github: triggersNotification: true githubCloudOnly: false @@ -79249,8 +78943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -79266,9 +78960,9 @@ paths: default: *541 headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79285,8 +78979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80138,7 +79832,7 @@ paths: color: red headers: Link: *58 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80155,8 +79849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80187,9 +79881,9 @@ paths: default: false headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80206,8 +79900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80270,9 +79964,9 @@ paths: items: *73 examples: default: *542 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '422': *15 x-github: githubCloudOnly: false @@ -80289,8 +79983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80354,9 +80048,9 @@ paths: items: *73 examples: default: *542 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '422': *15 x-github: githubCloudOnly: false @@ -80373,15 +80067,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '204': description: Response - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80400,8 +80094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: name in: path @@ -80426,9 +80120,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80448,8 +80142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80478,7 +80172,7 @@ paths: '204': description: Response '403': *29 - '410': *532 + '410': *530 '404': *6 '422': *15 x-github: @@ -80496,8 +80190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '204': @@ -80528,8 +80222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '200': @@ -80539,9 +80233,9 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80558,8 +80252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -80586,13 +80280,13 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80610,8 +80304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80644,16 +80338,16 @@ paths: description: Response content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Response content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -80675,10 +80369,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *539 - - *332 + - *534 responses: '204': description: Response @@ -80707,8 +80401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80766,8 +80460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80784,7 +80478,7 @@ paths: headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80812,8 +80506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80850,7 +80544,7 @@ paths: schema: type: string '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -80870,8 +80564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80927,8 +80621,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -81474,7 +81168,7 @@ paths: type: string comments: type: array - items: *465 + items: *461 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -81763,7 +81457,7 @@ paths: headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81780,8 +81474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -81857,8 +81551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -81930,8 +81624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 - &558 name: key_id description: The unique identifier of the key. @@ -81964,8 +81658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 - *558 responses: '204': @@ -81986,8 +81680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -82020,8 +81714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82091,8 +81785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82122,8 +81816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82188,8 +81882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82215,8 +81909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -82255,9 +81949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *334 - - *335 - - *438 + - *330 + - *331 + - *434 responses: '200': description: Response @@ -82402,8 +82096,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82468,8 +82162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82503,7 +82197,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *466 + schema: *464 examples: default: *560 '204': @@ -82530,8 +82224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *334 - - *335 + - *330 + - *331 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -82633,8 +82327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82735,8 +82429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - &563 name: milestone_number description: The number that identifies the milestone. @@ -82768,8 +82462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 requestBody: required: false @@ -82826,8 +82520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 responses: '204': @@ -82849,8 +82543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 - *17 - *19 @@ -82882,8 +82576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 - *564 - *565 - *81 @@ -82923,8 +82617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -82982,8 +82676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -83155,8 +82849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83235,8 +82929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83335,8 +83029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -83362,8 +83056,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -83467,8 +83161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -83513,8 +83207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -83570,8 +83264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *334 - - *335 + - *330 + - *331 - name: build_id in: path required: true @@ -83604,8 +83298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83710,8 +83404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 - &572 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -83770,8 +83464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 - *572 responses: '204': *183 @@ -83799,8 +83493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -84058,8 +83752,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Private vulnerability reporting status @@ -84096,8 +83790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '422': *14 @@ -84118,8 +83812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '422': *14 @@ -84141,8 +83835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -84174,8 +83868,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -84229,8 +83923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *334 - - *335 + - *330 + - *331 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -84290,7 +83984,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: *575 headers: @@ -84324,8 +84018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -85223,8 +84917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: sort in: query required: false @@ -85332,8 +85026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': @@ -85417,8 +85111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -85459,8 +85153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -85482,8 +85176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -85510,9 +85204,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -85533,8 +85227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -85567,16 +85261,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -85598,10 +85292,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - *534 responses: '204': description: Response @@ -85644,8 +85338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - &581 name: pull_number description: The number that identifies the pull request. @@ -85696,8 +85390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -85764,8 +85458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -85828,7 +85522,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -85836,7 +85530,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -85866,8 +85560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *98 - name: direction @@ -85924,8 +85618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -86119,8 +85813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *90 requestBody: @@ -86230,8 +85924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -86242,7 +85936,7 @@ paths: application/json: schema: type: array - items: *466 + items: *464 examples: default: *583 headers: @@ -86274,8 +85968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -86286,7 +85980,7 @@ paths: application/json: schema: type: array - items: *479 + items: *477 examples: default: value: @@ -86324,8 +86018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *334 - - *335 + - *330 + - *331 - *581 responses: '204': @@ -86349,8 +86043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -86462,8 +86156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 responses: '200': @@ -86539,8 +86233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -86578,7 +86272,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -87114,8 +86808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -87150,7 +86844,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -87655,8 +87349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -87818,8 +87512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -87971,8 +87665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - &585 name: review_id @@ -88047,8 +87741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88135,8 +87829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 responses: @@ -88173,8 +87867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 - *17 @@ -88411,8 +88105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88505,8 +88199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88567,8 +88261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -88632,8 +88326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *334 - - *335 + - *330 + - *331 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -88690,8 +88384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *334 - - *335 + - *330 + - *331 - name: dir description: The alternate path to look for a README file in: path @@ -88735,8 +88429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -88840,8 +88534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -89024,8 +88718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - &592 name: asset_id description: The unique identifier of the asset. @@ -89075,7 +88769,7 @@ paths: type: User site_admin: false '404': *6 - '302': *481 + '302': *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89091,8 +88785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - *592 requestBody: required: false @@ -89139,8 +88833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - *592 responses: '204': @@ -89165,8 +88859,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -89251,8 +88945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -89277,8 +88971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *334 - - *335 + - *330 + - *331 - name: tag description: tag parameter in: path @@ -89315,8 +89009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *334 - - *335 + - *330 + - *331 - &595 name: release_id description: The unique identifier of the release. @@ -89351,8 +89045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 requestBody: required: false @@ -89440,8 +89134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 responses: '204': @@ -89462,8 +89156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *334 - - *335 + - *330 + - *331 - *595 - *17 - *19 @@ -89555,8 +89249,8 @@ 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: - - *334 - - *335 + - *330 + - *331 - *595 - name: name in: query @@ -89638,8 +89332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -89664,9 +89358,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -89687,8 +89381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 requestBody: required: true @@ -89719,16 +89413,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -89750,10 +89444,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *595 - - *332 + - *534 responses: '204': description: Response @@ -89777,9 +89471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 - *17 - *19 responses: @@ -89916,8 +89610,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - name: includes_parents @@ -89983,8 +89677,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 requestBody: description: Request body required: true @@ -90093,8 +89787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *334 - - *335 + - *330 + - *331 - *600 - *601 - *602 @@ -90129,8 +89823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *334 - - *335 + - *330 + - *331 - *606 responses: '200': @@ -90167,8 +89861,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90208,8 +89902,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90291,8 +89985,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90315,8 +90009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - name: ruleset_id @@ -90353,8 +90047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90427,8 +90121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *612 - *613 - *614 @@ -90715,9 +90409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *622 responses: '200': @@ -90778,9 +90472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: true content: @@ -90918,9 +90612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *19 - *17 responses: @@ -91055,8 +90749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91134,8 +90828,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: - - *334 - - *335 + - *330 + - *331 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -91254,8 +90948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *334 - - *335 + - *330 + - *331 - *52 - name: sort description: The property to sort the results by. @@ -91324,8 +91018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91720,8 +91414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91972,8 +91666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '200': @@ -92006,8 +91700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 requestBody: required: true @@ -92208,8 +91902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '202': *39 @@ -92237,17 +91931,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '202': description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 '400': *14 '422': *15 '403': *29 @@ -92273,8 +91967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -92373,8 +92067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -92416,8 +92110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -92493,8 +92187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -92590,8 +92284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -92745,8 +92439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -92789,8 +92483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *334 - - *335 + - *330 + - *331 - name: sha in: path required: true @@ -92898,8 +92592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -92931,8 +92625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: if you subscribe to the repository @@ -93006,8 +92700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -93060,8 +92754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -93081,8 +92775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -93161,8 +92855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93222,8 +92916,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -93277,8 +92971,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: - - *334 - - *335 + - *330 + - *331 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -93315,8 +93009,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *334 - - *335 + - *330 + - *331 - name: ref in: path required: true @@ -93352,8 +93046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -93385,8 +93079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 responses: @@ -93429,8 +93123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -93484,8 +93178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *334 - - *335 + - *330 + - *331 - &653 name: per description: The time frame to display results for. @@ -93603,8 +93297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93695,8 +93389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93757,8 +93451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *334 - - *335 + - *330 + - *331 - *653 responses: '200': @@ -93856,8 +93550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -94131,8 +93825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -94155,8 +93849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -94178,8 +93872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -94205,8 +93899,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *334 - - *335 + - *330 + - *331 - name: ref in: path required: true @@ -94298,9 +93992,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -94781,7 +94475,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true comment_count: type: integer @@ -94801,7 +94495,7 @@ paths: url: type: string format: uri - verification: *518 + verification: *516 required: - author - committer @@ -94820,7 +94514,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true parents: type: array @@ -97017,246 +96711,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - *660 - - *325 - - *328 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - *660 - - *325 - - *328 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - *660 - - *325 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - *660 - - *325 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -97482,7 +96936,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-user-is-a-team-maintainer: *665 '404': *6 @@ -97543,7 +96997,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-users-membership-with-team-is-now-pending: *666 '403': @@ -97650,8 +97104,8 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Alternative response with extra repository information @@ -97809,8 +97263,8 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -97861,8 +97315,8 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -98634,7 +98088,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -98642,7 +98096,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -98726,7 +98180,7 @@ paths: - visibility - selected_repositories_url examples: - default: *458 + default: *454 headers: Link: *58 x-github: @@ -99100,7 +98554,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '304': *37 '500': *111 '401': *25 @@ -99158,7 +98612,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -99421,13 +98875,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *337 + repository: *333 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *456 - required: *457 + properties: *452 + required: *453 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -100209,7 +99663,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '304': *37 '500': *111 '400': *14 @@ -100249,7 +99703,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '500': *111 '401': *25 '403': *29 @@ -101397,7 +100851,7 @@ paths: required: true content: application/json: - schema: *529 + schema: *527 examples: default: value: @@ -103826,9 +103280,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -103866,7 +103320,7 @@ paths: application/json: schema: type: array - items: *531 + items: *529 examples: default: *690 headers: @@ -104480,8 +103934,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: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response if this repository is starred by you @@ -104509,8 +103963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -104534,8 +103988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -105215,7 +104669,7 @@ paths: initiator: type: string examples: - default: *395 + default: *391 '201': description: Response content: @@ -105746,7 +105200,7 @@ paths: application/json: schema: *22 examples: - default: *528 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113056,7 +112510,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113379,7 +112833,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113709,7 +113163,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114051,7 +113505,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114321,7 +113775,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114602,7 +114056,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114913,7 +114367,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116012,7 +115466,7 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116100,7 +115554,7 @@ x-webhooks: type: string enum: - auto_reopened - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116188,7 +115642,7 @@ x-webhooks: type: string enum: - created - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116274,7 +115728,7 @@ x-webhooks: type: string enum: - dismissed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116360,7 +115814,7 @@ x-webhooks: type: string enum: - fixed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116447,7 +115901,7 @@ x-webhooks: type: string enum: - reintroduced - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116533,7 +115987,7 @@ x-webhooks: type: string enum: - reopened - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -118026,7 +117480,7 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *493 + deployment: *491 pull_requests: type: array items: *579 @@ -220173,7 +219627,7 @@ x-webhooks: enterprise: *724 installation: *725 organization: *726 - repository: *337 + repository: *333 sender: *4 required: - changes @@ -225396,7 +224850,7 @@ x-webhooks: type: string required: - conclusion - deployment: *493 + deployment: *491 required: - action - repository @@ -225738,7 +225192,7 @@ x-webhooks: required: - status - steps - deployment: *493 + deployment: *491 required: - action - repository @@ -225955,7 +225409,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *493 + deployment: *491 required: - action - repository @@ -226173,7 +225627,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *493 + deployment: *491 required: - action - repository diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 3b585b29c..f88e1a08f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -201227,17 +201227,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/invitations": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -201258,43 +201258,6 @@ "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" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -201322,19 +201285,37 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Organization Invitation", + "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64" }, - "node_id": { + "login": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "nullable": true }, - "user": { + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -201456,36 +201437,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -201494,29 +201473,36 @@ "value": [ { "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "login": "octocat", + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -201536,20 +201522,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/teams/members#list-team-members" }, "parameters": [ { @@ -201571,238 +201559,175 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "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 when the reaction type has already been added to this team discussion comment", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "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": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -201821,239 +201746,144 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } + } + ] } } } + }, + "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" } }, - "201": { + { + "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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { + "url": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "format": "uri" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "nullable": true + "default": "member", + "example": "member", + "type": "string" }, - "content": { - "description": "The reaction to use", - "example": "heart", + "state": { + "description": "The state of the user's membership in the team.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "active", + "pending" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "role", + "state", + "url" ] }, "examples": { - "default": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\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": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -202075,57 +201905,177 @@ } }, { - "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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/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": "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": "reaction_id", - "description": "The unique identifier of the reaction.", + "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": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -202146,34 +202096,6 @@ "type": "string" } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -202201,19 +202123,28 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "user": { + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -202335,36 +202266,540 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "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" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "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", - "user", - "content", - "created_at" + "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" ] } }, @@ -202372,9 +202807,11 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -202394,8 +202831,98 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } } ] } @@ -202415,20 +202942,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "teams" } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/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/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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -202450,274 +202979,127 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "Response", + "description": "Alternative response with repository permissions", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { "id": { - "type": "integer", - "example": 1 + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" }, "node_id": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "key": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "mit" }, - "gravatar_id": { + "name": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MIT License" }, "url": { "type": "string", + "nullable": true, "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://api.github.com/licenses/mit" }, - "repos_url": { + "spdx_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "nullable": true, + "example": "MIT" }, - "events_url": { + "node_id": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "MDc6TGljZW5zZW1pdA==" }, - "received_events_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "type": { - "type": "string", - "example": "User" + "pull": { + "type": "boolean" }, - "site_admin": { + "triage": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "push": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "example": "public" + "maintain": { + "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "admin", + "pull", + "push" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { + "role_name": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "admin" }, - "user": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -202842,88 +203224,693 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "created_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "example": false + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "examples": { + "alternative-response-with-repository-permissions": { + "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, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, + "404": { + "description": "Not Found if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + } + } + }, + "examples": { + "default": { + "summary": "Adding a team to an organization repository with the write role", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -202945,21 +203932,21 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -202971,22 +203958,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "teams" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/teams/{team_slug}/teams": { "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`.", + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -203028,230 +204015,252 @@ ], "responses": { "200": { - "description": "Response", + "description": "if child teams exist", "content": { "application/json": { "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string", - "nullable": true + "type": "integer" }, - "email": { - "type": "string", - "nullable": true + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": "string", "nullable": true }, - "failed_reason": { - "type": "string", - "nullable": true + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "pull": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "triage": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - }, - "invitation_teams_url": { - "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" - }, - "invitation_source": { - "type": "string", - "example": "\"member\"" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true } }, "required": [ "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] } }, "examples": { - "default": { + "response-if-child-teams-exist": { "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": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/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 + "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" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "html_url": "https://github.com/orgs/rails/teams/core" } ] } @@ -203272,21 +204281,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "members" + "subcategory": "teams" } } }, - "/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.", + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/list-members-in-org", + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -203299,537 +204308,589 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "security_product", "in": "path", + "description": "The security feature to enable or disable.", "required": true, - "schema": { - "type": "string" - } - }, - { - "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 + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] } }, { - "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", + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "value": null } } } } }, + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "/rate_limit": { "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).", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "teams" + "rate-limit" ], - "operationId": "teams/get-membership-for-user-in-org", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-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" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" + ] }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "role", - "state", - "url" + "rate", + "resources" ] }, "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", + "default": { "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "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" - } + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, + "schema": { + "type": "integer" } }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } - } - }, - "responses": { - "200": { - "description": "Response", + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", + "documentation_url": { "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "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" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/orgs/{org}/teams/{team_slug}/repos": { + "/repos/{owner}/{repo}": { "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list-repos-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "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": { @@ -203837,31 +204898,13 @@ } }, { - "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/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": { @@ -203870,984 +204913,27 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "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" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - }, - "secret_scanning_non_provider_patterns": { - "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/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/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.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "example": "admin" - }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -204970,12 +205056,9 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -205199,11 +205282,11 @@ "example": 80 }, "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { - "description": "The default branch of the repository.", "type": "string", "example": "master" }, @@ -205212,8 +205295,6 @@ "example": 0 }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, "type": "boolean", "example": true }, @@ -205221,23 +205302,23 @@ "type": "array", "items": { "type": "string" - } + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, "type": "boolean", "example": true }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, "type": "boolean", "example": true }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, "type": "boolean", "example": true }, @@ -205245,14 +205326,14 @@ "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { "type": "boolean", "example": true }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { @@ -205261,2022 +205342,192 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "type": "string", + "example": "public" }, "pushed_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "example": "2011-01-26T19:06:43Z" }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "example": "2011-01-26T19:01:12Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false + "example": "2011-01-26T19:14:43Z" }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, + "allow_rebase_merge": { "type": "boolean", "example": true }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "example": false - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "examples": { - "alternative-response-with-repository-permissions": { - "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, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - } - } - } - } - }, - "204": { - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." - }, - "404": { - "description": "Not Found if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." - } - } - }, - "examples": { - "default": { - "summary": "Adding a team to an organization repository with the write role", - "value": { - "permission": "push" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-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" - } - }, - { - "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": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-child-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-child-teams" - }, - "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": "if child teams exist", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "html_url": "https://github.com/orgs/rails/teams/core" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/{security_product}/{enablement}": { - "post": { - "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "The security feature to enable or disable.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "query_suite": { - "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", - "type": "string", - "enum": [ - "default", - "extended" - ] - } - } - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "responses": { - "204": { - "description": "Action started" - }, - "422": { - "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "orgs", - "deprecationDate": "2024-07-22", - "removalDate": "2025-07-22" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "remaining": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "reset": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "used": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "graphql": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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, - "category": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", @@ -526604,2991 +524855,302 @@ }, "maintain": { "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "allow_auto_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 40, - "incomplete_results": false, - "items": [ - { - "id": 3081286, - "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", - "name": "Tetris", - "full_name": "dtrupenn/Tetris", - "owner": { - "login": "dtrupenn", - "id": 872147, - "node_id": "MDQ6VXNlcjg3MjE0Nw==", - "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/dtrupenn", - "received_events_url": "https://api.github.com/users/dtrupenn/received_events", - "type": "User", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "site_admin": true - }, - "private": false, - "html_url": "https://github.com/dtrupenn/Tetris", - "description": "A C implementation of Tetris using Pennsim through LC4", - "fork": false, - "url": "https://api.github.com/repos/dtrupenn/Tetris", - "created_at": "2012-01-01T00:31:50Z", - "updated_at": "2013-01-05T17:58:47Z", - "pushed_at": "2012-01-01T00:37:02Z", - "homepage": "https://github.com", - "size": 524, - "stargazers_count": 1, - "watchers_count": 1, - "language": "Assembly", - "forks_count": 0, - "open_issues_count": 0, - "master_branch": "master", - "default_branch": "master", - "score": 1, - "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", - "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", - "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", - "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", - "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", - "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", - "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", - "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", - "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", - "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", - "git_url": "git:github.com/dtrupenn/Tetris.git", - "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", - "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", - "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", - "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", - "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", - "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", - "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", - "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", - "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", - "ssh_url": "git@github.com:dtrupenn/Tetris.git", - "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", - "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", - "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", - "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", - "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", - "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", - "clone_url": "https://github.com/dtrupenn/Tetris.git", - "mirror_url": "git:git.example.com/dtrupenn/Tetris", - "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", - "svn_url": "https://svn.github.com/dtrupenn/Tetris", - "forks": 1, - "open_issues": 1, - "watchers": 1, - "has_issues": true, - "has_projects": true, - "has_pages": true, - "has_wiki": true, - "has_downloads": true, - "archived": true, - "disabled": true, - "visibility": "private", - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - } - } - ] - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/topics": { - "get": { - "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/topics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-topics" - }, - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", - "in": "query", - "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": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "display_name": { - "type": "string", - "nullable": true - }, - "short_description": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "created_by": { - "type": "string", - "nullable": true - }, - "released": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" - }, - "repository_count": { - "type": "integer", - "nullable": true - }, - "logo_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } - } - }, - "related": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - }, - "aliases": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } - } - } - } - } - } - }, - "required": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", - "created_at", - "updated_at", - "featured", - "curated", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 6, - "incomplete_results": false, - "items": [ - { - "name": "ruby", - "display_name": "Ruby", - "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", - "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", - "created_by": "Yukihiro Matsumoto", - "released": "December 21, 1995", - "created_at": "2016-11-28T22:03:59Z", - "updated_at": "2017-10-30T18:16:32Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "rails", - "display_name": "Rails", - "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", - "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", - "created_by": "David Heinemeier Hansson", - "released": "December 13 2005", - "created_at": "2016-12-09T17:03:50Z", - "updated_at": "2017-10-30T16:20:19Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "python", - "display_name": "Python", - "short_description": "Python is a dynamically typed programming language.", - "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", - "created_by": "Guido van Rossum", - "released": "February 20, 1991", - "created_at": "2016-12-07T00:07:02Z", - "updated_at": "2017-10-27T22:45:43Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "jekyll", - "display_name": "Jekyll", - "short_description": "Jekyll is a simple, blog-aware static site generator.", - "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", - "created_by": "Tom Preston-Werner", - "released": "2008", - "created_at": "2016-12-16T21:53:08Z", - "updated_at": "2017-10-27T19:00:24Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "sass", - "display_name": "Sass", - "short_description": "Sass is a stable extension to classic CSS.", - "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", - "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", - "released": "November 28, 2006", - "created_at": "2016-12-16T21:53:45Z", - "updated_at": "2018-01-16T16:30:40Z", - "featured": true, - "curated": true, - "score": 1 - }, - { - "name": "homebrew", - "display_name": "Homebrew", - "short_description": "Homebrew is a package manager for macOS.", - "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", - "created_by": "Max Howell", - "released": "2009", - "created_at": "2016-12-17T20:30:44Z", - "updated_at": "2018-02-06T16:14:56Z", - "featured": true, - "curated": true, - "score": 1 - } - ] - } - } - } - } - } - }, - "304": { - "description": "Not modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/users": { - "get": { - "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", - "tags": [ - "search" - ], - "operationId": "search/users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-users" - }, - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "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/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": "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", - "nullable": true - }, - "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", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "location": { - "type": "string", - "nullable": true - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "nullable": true, - "type": "string" - }, - "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", - "nullable": true - }, - "company": { - "type": "string", - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/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/rest/teams/teams#get-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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/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/rest/teams/teams#update-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team.", - "nullable": true - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "seats": { - "type": "integer" + "required": [ + "admin", + "pull", + "push" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" + "temp_clone_token": { + "type": "string" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "is_template": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + } }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "score" + ] + } } - }, - "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" - } + "total_count": 40, + "incomplete_results": false, + "items": [ + { + "id": 3081286, + "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", + "name": "Tetris", + "full_name": "dtrupenn/Tetris", + "owner": { + "login": "dtrupenn", + "id": 872147, + "node_id": "MDQ6VXNlcjg3MjE0Nw==", + "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/dtrupenn", + "received_events_url": "https://api.github.com/users/dtrupenn/received_events", + "type": "User", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "site_admin": true + }, + "private": false, + "html_url": "https://github.com/dtrupenn/Tetris", + "description": "A C implementation of Tetris using Pennsim through LC4", + "fork": false, + "url": "https://api.github.com/repos/dtrupenn/Tetris", + "created_at": "2012-01-01T00:31:50Z", + "updated_at": "2013-01-05T17:58:47Z", + "pushed_at": "2012-01-01T00:37:02Z", + "homepage": "https://github.com", + "size": 524, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Assembly", + "forks_count": 0, + "open_issues_count": 0, + "master_branch": "master", + "default_branch": "master", + "score": 1, + "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", + "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", + "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", + "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", + "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", + "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", + "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", + "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", + "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", + "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", + "git_url": "git:github.com/dtrupenn/Tetris.git", + "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", + "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", + "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", + "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", + "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", + "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", + "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", + "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", + "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", + "ssh_url": "git@github.com:dtrupenn/Tetris.git", + "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", + "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", + "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", + "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", + "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", + "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", + "clone_url": "https://github.com/dtrupenn/Tetris.git", + "mirror_url": "git:git.example.com/dtrupenn/Tetris", + "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", + "svn_url": "https://svn.github.com/dtrupenn/Tetris", + "forks": 1, + "open_issues": 1, + "watchers": 1, + "has_issues": true, + "has_projects": true, + "has_pages": true, + "has_wiki": true, + "has_downloads": true, + "archived": true, + "disabled": true, + "visibility": "private", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + } + } + ] } } } } } }, - "404": { - "description": "Resource not found", + "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" } } @@ -529665,208 +525227,392 @@ } } }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" } }, "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.", + "category": "search", + "subcategory": "search" + } + } + }, + "/search/topics": { + "get": { + "summary": "Search topics", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/delete-legacy", + "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/rest/search/search#search-topics" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", + "in": "query", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "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" - } - } - } - } + { + "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 } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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": { - "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": "Topic Search Result Item", + "description": "Topic Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "name": { "type": "string" }, - "field": { - "type": "string" + "display_name": { + "type": "string", + "nullable": true }, - "message": { - "type": "string" + "short_description": { + "type": "string", + "nullable": true }, - "code": { - "type": "string" + "description": { + "type": "string", + "nullable": true }, - "index": { - "type": "integer" + "created_by": { + "type": "string", + "nullable": true }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { + "released": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "featured": { + "type": "boolean" + }, + "curated": { + "type": "boolean" + }, + "score": { + "type": "number" + }, + "repository_count": { + "type": "integer", + "nullable": true + }, + "logo_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } - ] + } + }, + "related": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } + }, + "aliases": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } } - } + }, + "required": [ + "name", + "display_name", + "short_description", + "description", + "created_by", + "released", + "created_at", + "updated_at", + "featured", + "curated", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 6, + "incomplete_results": false, + "items": [ + { + "name": "ruby", + "display_name": "Ruby", + "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", + "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", + "created_by": "Yukihiro Matsumoto", + "released": "December 21, 1995", + "created_at": "2016-11-28T22:03:59Z", + "updated_at": "2017-10-30T18:16:32Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "rails", + "display_name": "Rails", + "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", + "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", + "created_by": "David Heinemeier Hansson", + "released": "December 13 2005", + "created_at": "2016-12-09T17:03:50Z", + "updated_at": "2017-10-30T16:20:19Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "python", + "display_name": "Python", + "short_description": "Python is a dynamically typed programming language.", + "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", + "created_by": "Guido van Rossum", + "released": "February 20, 1991", + "created_at": "2016-12-07T00:07:02Z", + "updated_at": "2017-10-27T22:45:43Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "jekyll", + "display_name": "Jekyll", + "short_description": "Jekyll is a simple, blog-aware static site generator.", + "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", + "created_by": "Tom Preston-Werner", + "released": "2008", + "created_at": "2016-12-16T21:53:08Z", + "updated_at": "2017-10-27T19:00:24Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "sass", + "display_name": "Sass", + "short_description": "Sass is a stable extension to classic CSS.", + "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", + "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", + "released": "November 28, 2006", + "created_at": "2016-12-16T21:53:45Z", + "updated_at": "2018-01-16T16:30:40Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "homebrew", + "display_name": "Homebrew", + "short_description": "Homebrew is a package manager for macOS.", + "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", + "created_by": "Max Howell", + "released": "2009", + "created_at": "2016-12-17T20:30:44Z", + "updated_at": "2018-02-06T16:14:56Z", + "featured": true, + "curated": true, + "score": 1 + } + ] + } + } } } } + }, + "304": { + "description": "Not modified" } }, "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": { + "/search/users": { "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.", + "summary": "Search users", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", "tags": [ - "teams" + "search" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/rest/search/search#search-users" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "in": "query", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "direction", - "description": "The direction to sort the results by.", + "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "asc", - "desc" + "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" } @@ -529896,113 +525642,188 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "type": "object", + "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": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { - "type": "string", - "example": "octocat" + "type": "string" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "type": "string" }, "avatar_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri" }, "gravatar_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "format": "uri" }, "html_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri" }, "followers_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, - "following_url": { + "subscriptions_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri" }, - "gists_url": { + "organizations_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri" }, - "starred_url": { + "repos_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { + "received_events_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { + "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": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time" }, - "repos_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "date-time" + }, + "name": { + "type": "string", + "nullable": true }, - "events_url": { + "bio": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "nullable": true }, - "received_events_url": { + "email": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "email", + "nullable": true }, - "type": { + "location": { "type": "string", - "example": "User" + "nullable": true }, "site_admin": { "type": "boolean" }, - "starred_at": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "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", - "example": "\"2020-07-09T00:17:55Z\"" + "nullable": true }, - "user_view_type": { + "company": { "type": "string", - "example": "public" + "nullable": true + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -530023,221 +525844,136 @@ "starred_url", "subscriptions_url", "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "score" ] } - }, - "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", + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "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/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/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", - "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 + "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 } - } - ] + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { "schema": { - "type": "string" + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } @@ -530246,23 +525982,22 @@ "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.", + "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/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/create-discussion-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -530275,406 +526010,616 @@ } } ], - "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": { + "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": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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/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/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/rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -530685,763 +526630,1317 @@ "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", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -531450,20 +527949,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": [ { @@ -531474,20 +527973,106 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -531496,22 +528081,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": [ { @@ -531523,15 +528108,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.", @@ -531573,8 +528149,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": { @@ -531703,57 +528279,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -531810,12 +528410,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -531845,19 +528450,24 @@ "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", + "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, - "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, @@ -531890,20 +528500,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": [ { @@ -531914,15 +528524,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -531932,19 +528533,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." } } } @@ -531957,8 +528569,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": { @@ -532087,57 +528699,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532194,12 +528830,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532227,19 +528868,24 @@ "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", + "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, - "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, @@ -532264,22 +528910,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": [ { @@ -532299,15 +528945,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -532316,8 +528953,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": { @@ -532446,57 +529083,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532553,12 +529214,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532586,19 +529252,24 @@ "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", + "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, - "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, @@ -532622,20 +529293,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": [ { @@ -532655,37 +529326,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" } } } @@ -532698,8 +529361,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": { @@ -532828,57 +529491,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -532935,12 +529622,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -532968,19 +529660,24 @@ "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", + "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", - "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, @@ -533004,20 +529701,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": [ { @@ -533037,15 +529734,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -533059,22 +529747,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}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", + "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -533096,31 +529784,17 @@ } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -533150,19 +529824,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -533287,33 +529953,122 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] } }, @@ -533321,9 +530076,7 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -533343,8 +530096,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -533364,23 +530138,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -533400,15 +530174,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -533418,29 +530183,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like apples?" } } } @@ -533453,19 +530208,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -533590,41 +530337,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -533644,8 +530478,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -533654,27 +530509,28 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-legacy", + "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -533696,40 +530552,12 @@ } }, { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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", + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -533739,239 +530567,326 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "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": [ - { + "value": { + "author": { + "login": "octocat", "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-legacy", + "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -533991,6 +530906,15 @@ "schema": { "type": "integer" } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -534000,29 +530924,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like pineapples?" } } } @@ -534030,24 +530944,16 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -534172,41 +531078,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -534226,8 +531219,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -534237,11 +531251,66 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "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": [ + { + "name": "team_id", + "description": "The unique identifier of the team.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "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, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index ed8839170..9b6b6b39e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -8795,7 +8795,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &483 + - &481 name: has in: query description: |- @@ -8911,7 +8911,7 @@ paths: - unknown - direct - transitive - security_advisory: &484 + security_advisory: &482 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9173,14 +9173,14 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &485 + auto_dismissed_at: &483 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &486 + dismissal_request: &484 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -11424,7 +11424,7 @@ paths: action: type: string issue: *74 - comment: &533 + comment: &531 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -16110,14 +16110,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &334 + - &330 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &335 + - &331 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16179,7 +16179,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &338 + '301': &334 description: Moved permanently content: application/json: @@ -19486,7 +19486,7 @@ paths: type: integer repository_cache_usages: type: array - items: &345 + items: &341 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20678,7 +20678,7 @@ paths: - all - local_only - selected - selected_actions_url: &351 + selected_actions_url: &347 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -20761,7 +20761,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &351 type: object properties: days: @@ -20803,7 +20803,7 @@ paths: required: true content: application/json: - schema: &356 + schema: &352 type: object properties: days: @@ -20860,7 +20860,7 @@ paths: required: - approval_policy examples: - default: &357 + default: &353 value: approval_policy: first_time_contributors '404': *6 @@ -20919,7 +20919,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &354 type: object required: - run_workflows_from_fork_pull_requests @@ -20973,7 +20973,7 @@ paths: required: true content: application/json: - schema: &359 + schema: &355 type: object required: - run_workflows_from_fork_pull_requests @@ -21608,7 +21608,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &356 type: object properties: default_workflow_permissions: &144 @@ -21659,7 +21659,7 @@ paths: required: false content: application/json: - schema: &361 + schema: &357 type: object properties: default_workflow_permissions: *144 @@ -22790,7 +22790,7 @@ paths: application/json: schema: type: array - items: &362 + items: &358 title: Runner Application description: Runner Application type: object @@ -22815,7 +22815,7 @@ paths: - download_url - filename examples: - default: &363 + default: &359 value: - os: osx architecture: x64 @@ -22901,7 +22901,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &364 + '201': &360 description: Response content: application/json: @@ -23012,7 +23012,7 @@ paths: - token - expires_at examples: - default: &365 + default: &361 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23051,7 +23051,7 @@ paths: application/json: schema: *155 examples: - default: &366 + default: &362 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23085,7 +23085,7 @@ paths: application/json: schema: *153 examples: - default: &367 + default: &363 value: id: 23 name: MBP @@ -23311,7 +23311,7 @@ paths: - *67 - *152 responses: - '200': &368 + '200': &364 description: Response content: application/json: @@ -23368,7 +23368,7 @@ paths: parameters: - *67 - *152 - - &369 + - &365 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23498,7 +23498,7 @@ paths: description: Response content: application/json: - schema: &381 + schema: &377 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23527,7 +23527,7 @@ paths: - key_id - key examples: - default: &382 + default: &378 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23940,7 +23940,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *67 - - &350 + - &346 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)." @@ -25482,7 +25482,7 @@ paths: initiator: type: string examples: - default: &395 + default: &391 value: attestations: - bundle: @@ -26411,7 +26411,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *67 - - &420 + - &416 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`, @@ -26421,7 +26421,7 @@ paths: schema: &176 type: string description: The name of the tool used to generate the code scanning analysis. - - &421 + - &417 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 @@ -26444,7 +26444,7 @@ paths: be returned. in: query required: false - schema: &423 + schema: &419 type: string description: State of a code scanning alert. enum: @@ -26467,7 +26467,7 @@ paths: be returned. in: query required: false - schema: &424 + schema: &420 type: string description: Severity of a code scanning alert. enum: @@ -26501,7 +26501,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: &425 + instances_url: &421 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -26524,7 +26524,7 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: &426 + dismissed_reason: &422 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -26533,13 +26533,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &427 + dismissed_comment: &423 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &428 + rule: &424 type: object properties: id: @@ -26592,7 +26592,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &429 + tool: &425 type: object properties: name: *176 @@ -26602,26 +26602,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *177 - most_recent_instance: &430 + most_recent_instance: &426 type: object properties: - ref: &422 + ref: &418 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &440 + analysis_key: &436 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: &441 + environment: &437 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: &442 + category: &438 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -26635,7 +26635,7 @@ paths: properties: text: type: string - location: &443 + location: &439 type: object description: Describe a region within a file for the alert. properties: @@ -26656,7 +26656,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: &444 + items: &440 type: string description: A classification of the file. For example to identify it as generated. @@ -27945,7 +27945,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &456 + properties: &452 name: type: string description: The name of the machine. @@ -27987,7 +27987,7 @@ paths: - ready - in_progress nullable: true - required: &457 + required: &453 - name - display_name - operating_system @@ -28855,7 +28855,7 @@ paths: - updated_at - visibility examples: - default: &458 + default: &454 value: total_count: 2 secrets: @@ -28893,7 +28893,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &455 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28922,7 +28922,7 @@ paths: - key_id - key examples: - default: &460 + default: &456 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28954,7 +28954,7 @@ paths: application/json: schema: *186 examples: - default: &462 + default: &458 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -30567,7 +30567,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &487 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -30584,7 +30584,7 @@ paths: - key_id - key examples: - default: &490 + default: &488 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32384,7 +32384,7 @@ paths: application/json: schema: *22 examples: - default: &528 + default: &526 value: id: 1 account: @@ -32609,7 +32609,7 @@ paths: required: true content: application/json: - schema: &529 + schema: &527 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -33462,7 +33462,7 @@ paths: application/json: schema: *232 examples: - default: &455 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -37845,7 +37845,7 @@ paths: content: oneOf: - *74 - - &470 + - &468 title: Pull Request Simple description: Pull Request Simple type: object @@ -40860,7 +40860,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &333 title: Full Repository description: Full Repository type: object @@ -41253,7 +41253,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &475 + properties: &473 url: type: string format: uri @@ -41269,7 +41269,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &476 + required: &474 - url - key - name @@ -41358,7 +41358,7 @@ paths: - network_count - subscribers_count examples: - default: &339 + default: &335 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -47702,407 +47702,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - *67 - - *68 - - *325 - - *328 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &329 - title: Reaction - description: Reactions to conversations provide a way to help people - express their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &331 - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - *67 - - *68 - - *325 - - *328 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: *329 - examples: - default: &330 - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - *67 - - *68 - - *325 - - *328 - - &332 - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - *67 - - *68 - - *325 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - *67 - - *68 - - *325 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - *67 - - *68 - - *325 - - *332 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -48215,7 +47814,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &329 title: Team Membership description: Team Membership type: object @@ -48305,7 +47904,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-users-membership-with-team-is-now-pending: &666 summary: Response if user's membership with team is now pending @@ -48414,8 +48013,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Alternative response with repository permissions @@ -48992,8 +48591,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -49040,8 +48639,8 @@ paths: parameters: - *67 - *68 - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -49232,7 +48831,7 @@ paths: resources: type: object properties: - core: &336 + core: &332 title: Rate Limit type: object properties: @@ -49249,21 +48848,21 @@ paths: - remaining - reset - used - graphql: *336 - search: *336 - code_search: *336 - source_import: *336 - integration_manifest: *336 - code_scanning_upload: *336 - actions_runner_registration: *336 - scim: *336 - dependency_snapshots: *336 - dependency_sbom: *336 - code_scanning_autofix: *336 + graphql: *332 + search: *332 + code_search: *332 + source_import: *332 + integration_manifest: *332 + code_scanning_upload: *332 + actions_runner_registration: *332 + scim: *332 + dependency_snapshots: *332 + dependency_sbom: *332 + code_scanning_autofix: *332 required: - core - search - rate: *336 + rate: *332 required: - rate - resources @@ -49368,14 +48967,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *337 + schema: *333 examples: default-response: summary: Default response @@ -49876,7 +49475,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *338 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49894,8 +49493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -50142,10 +49741,10 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 - '307': &340 + default: *335 + '307': &336 description: Temporary Redirect content: application/json: @@ -50174,8 +49773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -50197,7 +49796,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *340 + '307': *336 '404': *6 '409': *51 x-github: @@ -50221,11 +49820,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - - &373 + - &369 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50248,7 +49847,7 @@ paths: type: integer artifacts: type: array - items: &341 + items: &337 title: Artifact description: An artifact type: object @@ -50326,7 +49925,7 @@ paths: - expires_at - updated_at examples: - default: &374 + default: &370 value: total_count: 2 artifacts: @@ -50387,9 +49986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *334 - - *335 - - &342 + - *330 + - *331 + - &338 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50401,7 +50000,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *337 examples: default: value: @@ -50439,9 +50038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *334 - - *335 - - *342 + - *330 + - *331 + - *338 responses: '204': description: Response @@ -50465,9 +50064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *334 - - *335 - - *342 + - *330 + - *331 + - *338 - name: archive_format in: path required: true @@ -50481,7 +50080,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': &532 + '410': &530 description: Gone content: application/json: @@ -50506,14 +50105,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &343 + schema: &339 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -50546,13 +50145,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *343 + schema: *339 examples: selected_actions: *42 responses: @@ -50581,14 +50180,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &344 + schema: &340 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -50621,13 +50220,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *344 + schema: *340 examples: selected_actions: *44 responses: @@ -50658,14 +50257,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *345 + schema: *341 examples: default: value: @@ -50691,11 +50290,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - - &346 + - &342 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 @@ -50729,7 +50328,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &343 title: Repository actions caches description: Repository actions caches type: object @@ -50771,7 +50370,7 @@ paths: - total_count - actions_caches examples: - default: &348 + default: &344 value: total_count: 1 actions_caches: @@ -50803,23 +50402,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: - - *334 - - *335 + - *330 + - *331 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *346 + - *342 responses: '200': description: Response content: application/json: - schema: *347 + schema: *343 examples: - default: *348 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50839,8 +50438,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: - - *334 - - *335 + - *330 + - *331 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50871,9 +50470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *334 - - *335 - - &349 + - *330 + - *331 + - &345 name: job_id description: The unique identifier of the job. in: path @@ -50885,7 +50484,7 @@ paths: description: Response content: application/json: - schema: &377 + schema: &373 title: Job description: Information of a job execution in a workflow run type: object @@ -51192,9 +50791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *334 - - *335 - - *349 + - *330 + - *331 + - *345 responses: '302': description: Response @@ -51222,9 +50821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *334 - - *335 - - *349 + - *330 + - *331 + - *345 requestBody: required: false content: @@ -51269,8 +50868,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Status response @@ -51320,8 +50919,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -51384,8 +50983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -51403,7 +51002,7 @@ paths: type: integer secrets: type: array - items: &379 + items: &375 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51423,7 +51022,7 @@ paths: - created_at - updated_at examples: - default: &380 + default: &376 value: total_count: 2 secrets: @@ -51456,9 +51055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *334 - - *335 - - *350 + - *330 + - *331 + - *346 - *19 responses: '200': @@ -51475,7 +51074,7 @@ paths: type: integer variables: type: array - items: &383 + items: &379 title: Actions Variable type: object properties: @@ -51505,7 +51104,7 @@ paths: - created_at - updated_at examples: - default: &384 + default: &380 value: total_count: 2 variables: @@ -51538,8 +51137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51548,11 +51147,11 @@ paths: schema: type: object properties: - enabled: &352 + enabled: &348 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *136 - selected_actions_url: *351 + selected_actions_url: *347 sha_pinning_required: *137 required: - enabled @@ -51581,8 +51180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51593,7 +51192,7 @@ paths: schema: type: object properties: - enabled: *352 + enabled: *348 allowed_actions: *136 sha_pinning_required: *137 required: @@ -51625,14 +51224,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &353 + schema: &349 type: object properties: access_level: @@ -51649,7 +51248,7 @@ paths: required: - access_level examples: - default: &354 + default: &350 value: access_level: organization x-github: @@ -51673,15 +51272,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *353 + schema: *349 examples: - default: *354 + default: *350 responses: '204': description: Response @@ -51705,14 +51304,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: default: value: @@ -51736,8 +51335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Empty response for successful settings update @@ -51747,7 +51346,7 @@ paths: required: true content: application/json: - schema: *356 + schema: *352 examples: default: summary: Set retention days @@ -51771,8 +51370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51780,7 +51379,7 @@ paths: application/json: schema: *138 examples: - default: *357 + default: *353 '404': *6 x-github: enabledForGitHubApps: true @@ -51799,8 +51398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51834,14 +51433,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *358 + schema: *354 examples: default: *139 '403': *29 @@ -51863,13 +51462,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *359 + schema: *355 examples: default: *139 responses: @@ -51895,8 +51494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -51923,8 +51522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -51956,14 +51555,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *360 + schema: *356 examples: default: *146 x-github: @@ -51986,8 +51585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Success response @@ -51998,7 +51597,7 @@ paths: required: true content: application/json: - schema: *361 + schema: *357 examples: default: *146 x-github: @@ -52027,8 +51626,8 @@ paths: in: query schema: type: string - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -52072,8 +51671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -52081,9 +51680,9 @@ paths: application/json: schema: type: array - items: *362 + items: *358 examples: - default: *363 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52105,8 +51704,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -52149,7 +51748,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *364 + '201': *360 '404': *6 '422': *7 '409': *51 @@ -52180,8 +51779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -52189,7 +51788,7 @@ paths: application/json: schema: *155 examples: - default: *365 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52217,8 +51816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -52226,7 +51825,7 @@ paths: application/json: schema: *155 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52248,8 +51847,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '200': @@ -52258,7 +51857,7 @@ paths: application/json: schema: *153 examples: - default: *367 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52279,8 +51878,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '204': @@ -52307,8 +51906,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: '200': *157 @@ -52333,8 +51932,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: - - *334 - - *335 + - *330 + - *331 - *152 requestBody: required: true @@ -52383,8 +51982,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: - - *334 - - *335 + - *330 + - *331 - *152 requestBody: required: true @@ -52434,11 +52033,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: - - *334 - - *335 + - *330 + - *331 - *152 responses: - '200': *368 + '200': *364 '404': *6 x-github: githubCloudOnly: false @@ -52465,10 +52064,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: - - *334 - - *335 + - *330 + - *331 - *152 - - *369 + - *365 responses: '200': *157 '404': *6 @@ -52496,9 +52095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *334 - - *335 - - &387 + - *330 + - *331 + - &383 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. @@ -52506,7 +52105,7 @@ paths: required: false schema: type: string - - &388 + - &384 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52514,7 +52113,7 @@ paths: required: false schema: type: string - - &389 + - &385 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52523,7 +52122,7 @@ paths: required: false schema: type: string - - &390 + - &386 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 @@ -52550,7 +52149,7 @@ paths: - pending - *17 - *19 - - &391 + - &387 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)." @@ -52559,7 +52158,7 @@ paths: schema: type: string format: date-time - - &370 + - &366 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52568,13 +52167,13 @@ paths: schema: type: boolean default: false - - &392 + - &388 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &393 + - &389 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52597,7 +52196,7 @@ paths: type: integer workflow_runs: type: array - items: &371 + items: &367 title: Workflow Run description: An invocation of a workflow type: object @@ -52745,7 +52344,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &415 + properties: &411 id: type: string description: SHA for the commit @@ -52796,7 +52395,7 @@ paths: - name - email nullable: true - required: &416 + required: &412 - id - tree_id - message @@ -52843,7 +52442,7 @@ paths: - workflow_url - pull_requests examples: - default: &394 + default: &390 value: total_count: 1 workflow_runs: @@ -53079,24 +52678,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *334 - - *335 - - &372 + - *330 + - *331 + - &368 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *370 + - *366 responses: '200': description: Response content: application/json: - schema: *371 + schema: *367 examples: - default: &375 + default: &371 value: id: 30433642 name: Build @@ -53337,9 +52936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '204': description: Response @@ -53362,9 +52961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -53483,9 +53082,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: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '201': description: Response @@ -53518,12 +53117,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 - *17 - *19 - - *373 + - *369 responses: '200': description: Response @@ -53539,9 +53138,9 @@ paths: type: integer artifacts: type: array - items: *341 + items: *337 examples: - default: *374 + default: *370 headers: Link: *58 x-github: @@ -53565,25 +53164,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *334 - - *335 - - *372 - - &376 + - *330 + - *331 + - *368 + - &372 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *370 + - *366 responses: '200': description: Response content: application/json: - schema: *371 + schema: *367 examples: - default: *375 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53606,10 +53205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *334 - - *335 + - *330 + - *331 + - *368 - *372 - - *376 - *17 - *19 responses: @@ -53627,9 +53226,9 @@ paths: type: integer jobs: type: array - items: *377 + items: *373 examples: - default: &378 + default: &374 value: total_count: 1 jobs: @@ -53742,10 +53341,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *334 - - *335 + - *330 + - *331 + - *368 - *372 - - *376 responses: '302': description: Response @@ -53773,9 +53372,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '202': description: Response @@ -53808,9 +53407,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: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: true content: @@ -53877,9 +53476,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '202': description: Response @@ -53912,9 +53511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 - 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 @@ -53944,9 +53543,9 @@ paths: type: integer jobs: type: array - items: *377 + items: *373 examples: - default: *378 + default: *374 headers: Link: *58 x-github: @@ -53971,9 +53570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '302': description: Response @@ -54000,9 +53599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '204': description: Response @@ -54029,9 +53628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -54091,7 +53690,7 @@ paths: items: type: object properties: - type: &498 + type: &496 type: string description: The type of reviewer. enum: @@ -54176,9 +53775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: true content: @@ -54225,7 +53824,7 @@ paths: application/json: schema: type: array - items: &493 + items: &491 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54331,7 +53930,7 @@ paths: - created_at - updated_at examples: - default: &494 + default: &492 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54387,9 +53986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: false content: @@ -54433,9 +54032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 requestBody: required: false content: @@ -54488,9 +54087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *334 - - *335 - - *372 + - *330 + - *331 + - *368 responses: '200': description: Response @@ -54627,8 +54226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -54646,9 +54245,9 @@ paths: type: integer secrets: type: array - items: *379 + items: *375 examples: - default: *380 + default: *376 headers: Link: *58 x-github: @@ -54673,16 +54272,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *381 + schema: *377 examples: - default: *382 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54704,17 +54303,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *379 + schema: *375 examples: - default: &511 + default: &509 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54740,8 +54339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -54799,8 +54398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -54826,9 +54425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *334 - - *335 - - *350 + - *330 + - *331 + - *346 - *19 responses: '200': @@ -54845,9 +54444,9 @@ paths: type: integer variables: type: array - items: *383 + items: *379 examples: - default: *384 + default: *380 headers: Link: *58 x-github: @@ -54870,8 +54469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -54923,17 +54522,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 responses: '200': description: Response content: application/json: - schema: *383 + schema: *379 examples: - default: &512 + default: &510 value: name: USERNAME value: octocat @@ -54959,8 +54558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 requestBody: required: true @@ -55003,8 +54602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 responses: '204': @@ -55030,8 +54629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -55049,7 +54648,7 @@ paths: type: integer workflows: type: array - items: &385 + items: &381 title: Workflow description: A GitHub Actions workflow type: object @@ -55156,9 +54755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *334 - - *335 - - &386 + - *330 + - *331 + - &382 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55173,7 +54772,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *381 examples: default: value: @@ -55206,9 +54805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55233,9 +54832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55286,9 +54885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '204': description: Response @@ -55315,19 +54914,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *334 - - *335 + - *330 + - *331 + - *382 + - *383 + - *384 + - *385 - *386 + - *17 + - *19 - *387 + - *366 - *388 - *389 - - *390 - - *17 - - *19 - - *391 - - *370 - - *392 - - *393 responses: '200': description: Response @@ -55343,9 +54942,9 @@ paths: type: integer workflow_runs: type: array - items: *371 + items: *367 examples: - default: *394 + default: *390 headers: Link: *58 x-github: @@ -55377,9 +54976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *334 - - *335 - - *386 + - *330 + - *331 + - *382 responses: '200': description: Response @@ -55440,8 +55039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *334 - - *335 + - *330 + - *331 - *52 - *17 - *45 @@ -55605,8 +55204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -55643,8 +55242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *334 - - *335 + - *330 + - *331 - name: assignee in: path required: true @@ -55680,8 +55279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -55793,8 +55392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *45 - *46 @@ -55851,7 +55450,7 @@ paths: initiator: type: string examples: - default: *395 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55871,8 +55470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -55880,7 +55479,7 @@ paths: application/json: schema: type: array - items: &396 + items: &392 title: Autolink reference description: An autolink reference. type: object @@ -55934,8 +55533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -55974,9 +55573,9 @@ paths: description: response content: application/json: - schema: *396 + schema: *392 examples: - default: &397 + default: &393 value: id: 1 key_prefix: TICKET- @@ -56007,9 +55606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *334 - - *335 - - &398 + - *330 + - *331 + - &394 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56021,9 +55620,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: *397 + default: *393 '404': *6 x-github: githubCloudOnly: false @@ -56043,9 +55642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *334 - - *335 - - *398 + - *330 + - *331 + - *394 responses: '204': description: Response @@ -56069,8 +55668,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response if Dependabot is enabled @@ -56118,8 +55717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -56140,8 +55739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -56161,8 +55760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *334 - - *335 + - *330 + - *331 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56200,7 +55799,7 @@ paths: - url protected: type: boolean - protection: &400 + protection: &396 title: Branch Protection description: Branch Protection type: object @@ -56242,7 +55841,7 @@ paths: required: - contexts - checks - enforce_admins: &403 + enforce_admins: &399 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56257,7 +55856,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &405 + required_pull_request_reviews: &401 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56333,7 +55932,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &402 + restrictions: &398 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56610,9 +56209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *334 - - *335 - - &401 + - *330 + - *331 + - &397 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). @@ -56626,14 +56225,14 @@ paths: description: Response content: application/json: - schema: &411 + schema: &407 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &466 + commit: &464 title: Commit description: Commit type: object @@ -56667,7 +56266,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &399 + properties: &395 name: type: string example: '"Chris Wanstrath"' @@ -56683,7 +56282,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true message: type: string @@ -56704,7 +56303,7 @@ paths: required: - sha - url - verification: &518 + verification: &516 title: Verification type: object properties: @@ -56774,7 +56373,7 @@ paths: type: integer files: type: array - items: &479 + items: &477 title: Diff Entry description: Diff Entry type: object @@ -56858,7 +56457,7 @@ paths: - self protected: type: boolean - protection: *400 + protection: *396 protection_url: type: string format: uri @@ -56965,7 +56564,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *338 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -56987,15 +56586,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *400 + schema: *396 examples: default: value: @@ -57189,9 +56788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -57446,7 +57045,7 @@ paths: url: type: string format: uri - required_status_checks: &408 + required_status_checks: &404 title: Status Check Policy description: Status Check Policy type: object @@ -57598,7 +57197,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *402 + restrictions: *398 required_conversation_resolution: type: object properties: @@ -57710,9 +57309,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -57737,17 +57336,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: &404 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -57769,17 +57368,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: *404 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57798,9 +57397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -57825,17 +57424,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *405 + schema: *401 examples: - default: &406 + default: &402 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -57931,9 +57530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58031,9 +57630,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *401 examples: - default: *406 + default: *402 '422': *15 x-github: githubCloudOnly: false @@ -58054,9 +57653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58083,17 +57682,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: &407 + default: &403 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58116,17 +57715,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *403 + schema: *399 examples: - default: *407 + default: *403 '404': *6 x-github: githubCloudOnly: false @@ -58146,9 +57745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58173,17 +57772,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *408 + schema: *404 examples: - default: &409 + default: &405 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58209,9 +57808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58263,9 +57862,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *404 examples: - default: *409 + default: *405 '404': *6 '422': *15 x-github: @@ -58287,9 +57886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58313,9 +57912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58349,9 +57948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58418,9 +58017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -58484,9 +58083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: content: application/json: @@ -58552,15 +58151,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response content: application/json: - schema: *402 + schema: *398 examples: default: value: @@ -58651,9 +58250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '204': description: Response @@ -58676,9 +58275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58688,7 +58287,7 @@ paths: type: array items: *5 examples: - default: &410 + default: &406 value: - id: 1 slug: octoapp @@ -58745,9 +58344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58781,7 +58380,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58802,9 +58401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58838,7 +58437,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58859,9 +58458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -58895,7 +58494,7 @@ paths: type: array items: *5 examples: - default: *410 + default: *406 '422': *15 x-github: githubCloudOnly: false @@ -58917,9 +58516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -58949,9 +58548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -59010,9 +58609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: false content: @@ -59071,9 +58670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: content: application/json: @@ -59132,9 +58731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 responses: '200': description: Response @@ -59168,9 +58767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59228,9 +58827,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59288,9 +58887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59350,9 +58949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 requestBody: required: true content: @@ -59374,7 +58973,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *407 examples: default: value: @@ -59490,8 +59089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -59770,7 +59369,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &408 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60170,9 +59769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *334 - - *335 - - &413 + - *330 + - *331 + - &409 name: check_run_id description: The unique identifier of the check run. in: path @@ -60184,9 +59783,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *408 examples: - default: &414 + default: &410 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60286,9 +59885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 requestBody: required: true content: @@ -60528,9 +60127,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *408 examples: - default: *414 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60550,9 +60149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 - *17 - *19 responses: @@ -60647,9 +60246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *334 - - *335 - - *413 + - *330 + - *331 + - *409 responses: '201': description: Response @@ -60693,8 +60292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -60716,7 +60315,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &417 + schema: &413 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -60806,8 +60405,8 @@ paths: title: Simple Commit description: A commit. type: object - properties: *415 - required: *416 + properties: *411 + required: *412 latest_check_runs_count: type: integer check_runs_url: @@ -60835,7 +60434,7 @@ paths: - check_runs_url - pull_requests examples: - default: &418 + default: &414 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61126,9 +60725,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61147,8 +60746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -61457,9 +61056,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *334 - - *335 - - &419 + - *330 + - *331 + - &415 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61471,9 +61070,9 @@ paths: description: Response content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61496,17 +61095,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *334 - - *335 - - *419 - - &472 + - *330 + - *331 + - *415 + - &470 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &473 + - &471 name: status description: Returns check runs with the specified `status`. in: query @@ -61545,9 +61144,9 @@ paths: type: integer check_runs: type: array - items: *412 + items: *408 examples: - default: &474 + default: &472 value: total_count: 1 check_runs: @@ -61649,9 +61248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *334 - - *335 - - *419 + - *330 + - *331 + - *415 responses: '201': description: Response @@ -61684,21 +61283,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *334 - - *335 - - *420 - - *421 + - *330 + - *331 + - *416 + - *417 - *19 - *17 - - &438 + - &434 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: *422 - - &439 + schema: *418 + - &435 name: pr description: The number of the pull request for the results you want to list. in: query @@ -61723,13 +61322,13 @@ paths: be returned. in: query required: false - schema: *423 + schema: *419 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *424 + schema: *420 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -61753,7 +61352,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: *425 + instances_url: *421 state: *178 fixed_at: *174 dismissed_by: @@ -61764,11 +61363,11 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: *426 - dismissed_comment: *427 - rule: *428 - tool: *429 - most_recent_instance: *430 + dismissed_reason: *422 + dismissed_comment: *423 + rule: *424 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -61894,7 +61493,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &431 + '403': &427 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -61921,9 +61520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *334 - - *335 - - &432 + - *330 + - *331 + - &428 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -61937,7 +61536,7 @@ paths: description: Response content: application/json: - schema: &433 + schema: &429 type: object properties: number: *169 @@ -61945,7 +61544,7 @@ paths: updated_at: *171 url: *172 html_url: *173 - instances_url: *425 + instances_url: *421 state: *178 fixed_at: *174 dismissed_by: @@ -61956,8 +61555,8 @@ paths: required: *21 nullable: true dismissed_at: *175 - dismissed_reason: *426 - dismissed_comment: *427 + dismissed_reason: *422 + dismissed_comment: *423 rule: type: object properties: @@ -62011,8 +61610,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *429 - most_recent_instance: *430 + tool: *425 + most_recent_instance: *426 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -62111,7 +61710,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62131,9 +61730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: true content: @@ -62148,8 +61747,8 @@ paths: enum: - open - dismissed - dismissed_reason: *426 - dismissed_comment: *427 + dismissed_reason: *422 + dismissed_comment: *423 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62177,7 +61776,7 @@ paths: description: Response content: application/json: - schema: *433 + schema: *429 examples: default: value: @@ -62253,7 +61852,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &437 + '403': &433 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -62280,15 +61879,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 responses: '200': description: Response content: application/json: - schema: &434 + schema: &430 type: object properties: status: @@ -62314,13 +61913,13 @@ paths: - description - started_at examples: - default: &435 + default: &431 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &436 + '400': &432 description: Bad Request content: application/json: @@ -62331,7 +61930,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': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62356,29 +61955,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 responses: '200': description: OK content: application/json: - schema: *434 + schema: *430 examples: - default: *435 + default: *431 '202': description: Accepted content: application/json: - schema: *434 + schema: *430 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *436 + '400': *432 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62410,9 +62009,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: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: false content: @@ -62457,8 +62056,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *436 - '403': *437 + '400': *432 + '403': *433 '404': *6 '422': description: Unprocessable Entity @@ -62482,13 +62081,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *19 - *17 - - *438 - - *439 + - *434 + - *435 responses: '200': description: Response @@ -62499,10 +62098,10 @@ paths: items: type: object properties: - ref: *422 - analysis_key: *440 - environment: *441 - category: *442 + ref: *418 + analysis_key: *436 + environment: *437 + category: *438 state: type: string description: State of a code scanning alert instance. @@ -62517,7 +62116,7 @@ paths: properties: text: type: string - location: *443 + location: *439 html_url: type: string classifications: @@ -62525,7 +62124,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: *444 + items: *440 examples: default: value: @@ -62564,7 +62163,7 @@ paths: end_column: 50 classifications: - source - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62598,25 +62197,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *334 - - *335 - - *420 - - *421 + - *330 + - *331 + - *416 + - *417 - *19 - *17 - - *439 + - *435 - 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: *422 + schema: *418 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &445 + schema: &441 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -62637,23 +62236,23 @@ paths: application/json: schema: type: array - items: &446 + items: &442 type: object properties: - ref: *422 - commit_sha: &454 + ref: *418 + commit_sha: &450 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: *440 + analysis_key: *436 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *442 + category: *438 error: type: string example: error reading field xyz @@ -62677,8 +62276,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *445 - tool: *429 + sarif_id: *441 + tool: *425 deletable: type: boolean warning: @@ -62739,7 +62338,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -62775,8 +62374,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: - - *334 - - *335 + - *330 + - *331 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -62789,7 +62388,7 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: response: summary: application/json response @@ -62843,7 +62442,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *431 + '403': *427 '404': *6 '422': description: Response if analysis could not be processed @@ -62930,8 +62529,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: - - *334 - - *335 + - *330 + - *331 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -62984,7 +62583,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': *437 + '403': *433 '404': *6 '503': *112 x-github: @@ -63006,8 +62605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -63015,7 +62614,7 @@ paths: application/json: schema: type: array - items: &447 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -63126,7 +62725,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': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -63155,8 +62754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: language in: path description: The language of the CodeQL database. @@ -63168,7 +62767,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: default: value: @@ -63200,9 +62799,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': &481 + '302': &479 description: Found - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -63224,8 +62823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *334 - - *335 + - *330 + - *331 - name: language in: path description: The language of the CodeQL database. @@ -63235,7 +62834,7 @@ paths: responses: '204': description: Response - '403': *437 + '403': *433 '404': *6 '503': *112 x-github: @@ -63263,8 +62862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -63273,7 +62872,7 @@ paths: type: object additionalProperties: false properties: - language: &448 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -63353,7 +62952,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &452 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63363,7 +62962,7 @@ paths: description: The ID of the variant analysis. controller_repo: *57 actor: *4 - query_language: *448 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -63410,7 +63009,7 @@ paths: items: type: object properties: - repository: &449 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -63446,7 +63045,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &453 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63478,7 +63077,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &450 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -63492,7 +63091,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: *449 + items: *445 required: - repository_count - repositories @@ -63514,8 +63113,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *450 - over_limit_repos: *450 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -63531,7 +63130,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &451 + value: &447 summary: Default response value: id: 1 @@ -63677,10 +63276,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *451 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *451 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission @@ -63708,8 +63307,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: - - *334 - - *335 + - *330 + - *331 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -63721,9 +63320,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *448 examples: - default: *451 + default: *447 '404': *6 '503': *112 x-github: @@ -63746,7 +63345,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: - - *334 + - *330 - name: repo in: path description: The name of the controller repository. @@ -63781,7 +63380,7 @@ paths: type: object properties: repository: *57 - analysis_status: *453 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -63906,8 +63505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -63992,7 +63591,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *431 + '403': *427 '404': *6 '503': *112 x-github: @@ -64013,8 +63612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64106,7 +63705,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *437 + '403': *433 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64177,8 +63776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64186,7 +63785,7 @@ paths: schema: type: object properties: - commit_sha: *454 + commit_sha: *450 ref: type: string description: |- @@ -64244,7 +63843,7 @@ paths: schema: type: object properties: - id: *445 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -64258,7 +63857,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': *437 + '403': *433 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -64281,8 +63880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *334 - - *335 + - *330 + - *331 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64328,7 +63927,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': *431 + '403': *427 '404': description: Not Found if the sarif id does not match any upload '503': *112 @@ -64353,8 +63952,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -64435,8 +64034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *334 - - *335 + - *330 + - *331 - 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 @@ -64556,8 +64155,8 @@ paths: parameters: - *17 - *19 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -64871,8 +64470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -64937,7 +64536,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -64945,7 +64544,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '400': *14 '401': *25 '403': *29 @@ -64974,8 +64573,8 @@ paths: parameters: - *17 - *19 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -65039,8 +64638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65079,8 +64678,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *456 - required: *457 + properties: *452 + required: *453 examples: default: &676 value: @@ -65122,8 +64721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *334 - - *335 + - *330 + - *331 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65207,8 +64806,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: - - *334 - - *335 + - *330 + - *331 - 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 @@ -65274,8 +64873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -65293,7 +64892,7 @@ paths: type: integer secrets: type: array - items: &461 + items: &457 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65313,7 +64912,7 @@ paths: - created_at - updated_at examples: - default: *458 + default: *454 headers: Link: *58 x-github: @@ -65336,16 +64935,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *459 + schema: *455 examples: - default: *460 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65365,17 +64964,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *461 + schema: *457 examples: - default: *462 + default: *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65395,8 +64994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -65449,8 +65048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -65479,8 +65078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *334 - - *335 + - *330 + - *331 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65522,7 +65121,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &463 + properties: &459 login: type: string example: octocat @@ -65615,7 +65214,7 @@ paths: user_view_type: type: string example: public - required: &464 + required: &460 - avatar_url - events_url - followers_url @@ -65689,8 +65288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '204': @@ -65737,8 +65336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 requestBody: required: false @@ -65765,7 +65364,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &531 + schema: &529 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -65994,8 +65593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '204': @@ -66027,8 +65626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *334 - - *335 + - *330 + - *331 - *63 responses: '200': @@ -66049,8 +65648,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *463 - required: *464 + properties: *459 + required: *460 nullable: true required: - permission @@ -66105,8 +65704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -66116,7 +65715,7 @@ paths: application/json: schema: type: array - items: &465 + items: &461 title: Commit Comment description: Commit Comment type: object @@ -66174,7 +65773,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &466 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66233,17 +65832,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': description: Response content: application/json: - schema: *465 + schema: *461 examples: - default: &469 + default: &467 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66300,8 +65899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -66324,7 +65923,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: default: value: @@ -66375,8 +65974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -66398,8 +65997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -66426,9 +66025,74 @@ paths: application/json: schema: type: array - items: *329 + items: &462 + title: Reaction + description: Reactions to conversations provide a way to help people + express their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *331 + default: &533 + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' headers: Link: *58 '404': *6 @@ -66449,8 +66113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -66483,16 +66147,40 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: &463 + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -66514,10 +66202,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - &534 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -66566,8 +66260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *334 - - *335 + - *330 + - *331 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -66623,7 +66317,7 @@ paths: application/json: schema: type: array - items: *466 + items: *464 examples: default: &583 value: @@ -66719,9 +66413,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *334 - - *335 - - &467 + - *330 + - *331 + - &465 name: commit_sha description: The SHA of the commit. in: path @@ -66793,9 +66487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 - *17 - *19 responses: @@ -66805,9 +66499,9 @@ paths: application/json: schema: type: array - items: *465 + items: *461 examples: - default: *468 + default: *466 headers: Link: *58 x-github: @@ -66835,9 +66529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 requestBody: required: true content: @@ -66872,9 +66566,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: - default: *469 + default: *467 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66902,9 +66596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 - *17 - *19 responses: @@ -66914,7 +66608,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: &575 value: @@ -67453,11 +67147,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 - - &471 + - &469 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)" @@ -67472,7 +67166,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: &560 value: @@ -67587,11 +67281,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *334 - - *335 + - *330 + - *331 + - *469 + - *470 - *471 - - *472 - - *473 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67625,9 +67319,9 @@ paths: type: integer check_runs: type: array - items: *412 + items: *408 examples: - default: *474 + default: *472 headers: Link: *58 x-github: @@ -67652,9 +67346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -67662,7 +67356,7 @@ paths: schema: type: integer example: 1 - - *472 + - *470 - *17 - *19 responses: @@ -67680,7 +67374,7 @@ paths: type: integer check_suites: type: array - items: *417 + items: *413 examples: default: value: @@ -67880,9 +67574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - *17 - *19 responses: @@ -68080,9 +67774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *334 - - *335 - - *471 + - *330 + - *331 + - *469 - *17 - *19 responses: @@ -68173,7 +67867,7 @@ paths: site_admin: false headers: Link: *58 - '301': *338 + '301': *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68201,8 +67895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -68231,20 +67925,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *475 - required: *476 + properties: *473 + required: *474 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &477 + properties: &475 url: type: string format: uri html_url: type: string format: uri - required: &478 + required: &476 - url - html_url nullable: true @@ -68258,26 +67952,26 @@ paths: contributing: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true readme: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true issue_template: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true pull_request_template: title: Community Health File type: object - properties: *477 - required: *478 + properties: *475 + required: *476 nullable: true required: - code_of_conduct @@ -68404,8 +68098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 - name: basehead @@ -68448,8 +68142,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *466 - merge_base_commit: *466 + base_commit: *464 + merge_base_commit: *464 status: type: string enum: @@ -68469,10 +68163,10 @@ paths: example: 6 commits: type: array - items: *466 + items: *464 files: type: array - items: *479 + items: *477 required: - url - html_url @@ -68758,8 +68452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -68902,7 +68596,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &480 + response-if-content-is-a-file: &478 summary: Response if content is a file value: type: file @@ -69235,7 +68929,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *480 + response-if-content-is-a-file: *478 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69304,7 +68998,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *481 + '302': *479 '304': *37 x-github: githubCloudOnly: false @@ -69327,8 +69021,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -69421,7 +69115,7 @@ paths: description: Response content: application/json: - schema: &482 + schema: &480 title: File Commit description: File Commit type: object @@ -69573,7 +69267,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *480 examples: example-for-creating-a-file: value: @@ -69627,7 +69321,7 @@ paths: schema: oneOf: - *3 - - &513 + - &511 description: Repository rule violation was detected type: object properties: @@ -69680,8 +69374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *334 - - *335 + - *330 + - *331 - name: path description: path parameter in: path @@ -69742,7 +69436,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *480 examples: default: value: @@ -69797,8 +69491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *334 - - *335 + - *330 + - *331 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -69921,8 +69615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *190 - *191 - *192 @@ -69934,7 +69628,7 @@ paths: schema: type: string - *194 - - *483 + - *481 - *195 - *196 - *52 @@ -69955,7 +69649,7 @@ paths: application/json: schema: type: array - items: &487 + items: &485 type: object description: A Dependabot alert. properties: @@ -70001,7 +69695,7 @@ paths: - unknown - direct - transitive - security_advisory: *484 + security_advisory: *482 security_vulnerability: *56 url: *172 html_url: *173 @@ -70032,8 +69726,8 @@ paths: nullable: true maxLength: 280 fixed_at: *174 - auto_dismissed_at: *485 - dismissal_request: *486 + auto_dismissed_at: *483 + dismissal_request: *484 required: - number - state @@ -70263,9 +69957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *334 - - *335 - - &488 + - *330 + - *331 + - &486 name: alert_number in: path description: |- @@ -70280,7 +69974,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *485 examples: default: value: @@ -70393,9 +70087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *334 - - *335 - - *488 + - *330 + - *331 + - *486 requestBody: required: true content: @@ -70440,7 +70134,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *485 examples: default: value: @@ -70569,8 +70263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -70588,7 +70282,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &489 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -70641,16 +70335,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: *490 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70670,15 +70364,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '200': description: Response content: application/json: - schema: *491 + schema: *489 examples: default: value: @@ -70704,8 +70398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 requestBody: required: true @@ -70758,8 +70452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *334 - - *335 + - *330 + - *331 - *159 responses: '204': @@ -70782,8 +70476,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: - - *334 - - *335 + - *330 + - *331 - 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 @@ -70943,8 +70637,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -71183,8 +70877,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -71259,7 +70953,7 @@ paths: - version - url additionalProperties: false - metadata: &492 + metadata: &490 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71292,7 +70986,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *492 + metadata: *490 resolved: type: object description: A collection of resolved package dependencies. @@ -71305,7 +70999,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *492 + metadata: *490 relationship: type: string description: A notation of whether a dependency is requested @@ -71434,8 +71128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *334 - - *335 + - *330 + - *331 - name: sha description: The SHA recorded at creation time. in: query @@ -71475,9 +71169,9 @@ paths: application/json: schema: type: array - items: *493 + items: *491 examples: - default: *494 + default: *492 headers: Link: *58 x-github: @@ -71543,8 +71237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -71625,7 +71319,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: simple-example: summary: Simple example @@ -71698,9 +71392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *334 - - *335 - - &495 + - *330 + - *331 + - &493 name: deployment_id description: deployment_id parameter in: path @@ -71712,7 +71406,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -71777,9 +71471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 responses: '204': description: Response @@ -71801,9 +71495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 - *17 - *19 responses: @@ -71813,7 +71507,7 @@ paths: application/json: schema: type: array - items: &496 + items: &494 title: Deployment Status description: The status of a deployment. type: object @@ -71974,9 +71668,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 requestBody: required: true content: @@ -72051,9 +71745,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *494 examples: - default: &497 + default: &495 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72109,9 +71803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *334 - - *335 - - *495 + - *330 + - *331 + - *493 - name: status_id in: path required: true @@ -72122,9 +71816,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *494 examples: - default: *497 + default: *495 '404': *6 x-github: githubCloudOnly: false @@ -72149,8 +71843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -72207,8 +71901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -72225,7 +71919,7 @@ paths: type: integer environments: type: array - items: &499 + items: &497 title: Environment description: Details of a deployment environment type: object @@ -72277,7 +71971,7 @@ paths: type: type: string example: wait_timer - wait_timer: &501 + wait_timer: &499 type: integer example: 30 description: The amount of time to delay a job after @@ -72314,7 +72008,7 @@ paths: items: type: object properties: - type: *498 + type: *496 reviewer: anyOf: - *4 @@ -72338,7 +72032,7 @@ paths: - id - node_id - type - deployment_branch_policy: &502 + deployment_branch_policy: &500 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -72454,9 +72148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *334 - - *335 - - &500 + - *330 + - *331 + - &498 name: environment_name in: path required: true @@ -72469,9 +72163,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *497 examples: - default: &503 + default: &501 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -72555,9 +72249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: false content: @@ -72566,7 +72260,7 @@ paths: type: object nullable: true properties: - wait_timer: *501 + wait_timer: *499 prevent_self_review: type: boolean example: false @@ -72583,13 +72277,13 @@ paths: items: type: object properties: - type: *498 + type: *496 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *502 + deployment_branch_policy: *500 additionalProperties: false examples: default: @@ -72609,9 +72303,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *497 examples: - default: *503 + default: *501 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -72635,9 +72329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 responses: '204': description: Default response @@ -72662,9 +72356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *17 - *19 responses: @@ -72682,7 +72376,7 @@ paths: example: 2 branch_policies: type: array - items: &504 + items: &502 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -72739,9 +72433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: true content: @@ -72787,9 +72481,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - example-wildcard: &505 + example-wildcard: &503 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -72831,10 +72525,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - &506 + - *330 + - *331 + - *498 + - &504 name: branch_policy_id in: path required: true @@ -72846,9 +72540,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - default: *505 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72867,10 +72561,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - *506 + - *330 + - *331 + - *498 + - *504 requestBody: required: true content: @@ -72898,9 +72592,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *502 examples: - default: *505 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72919,10 +72613,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *334 - - *335 - - *500 - - *506 + - *330 + - *331 + - *498 + - *504 responses: '204': description: Response @@ -72947,9 +72641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 responses: '200': description: List of deployment protection rules @@ -72965,7 +72659,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &507 + items: &505 title: Deployment protection rule description: Deployment protection rule type: object @@ -72984,7 +72678,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &508 + app: &506 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73083,9 +72777,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: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 requestBody: content: application/json: @@ -73106,9 +72800,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *507 + schema: *505 examples: - default: &509 + default: &507 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73143,9 +72837,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: - - *500 - - *335 - - *334 + - *498 + - *331 + - *330 - *19 - *17 responses: @@ -73164,7 +72858,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *508 + items: *506 examples: default: value: @@ -73199,10 +72893,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *334 - - *335 - - *500 - - &510 + - *330 + - *331 + - *498 + - &508 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73214,9 +72908,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *505 examples: - default: *509 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73237,10 +72931,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *500 - - *335 - - *334 - - *510 + - *498 + - *331 + - *330 + - *508 responses: '204': description: Response @@ -73266,9 +72960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *17 - *19 responses: @@ -73286,9 +72980,9 @@ paths: type: integer secrets: type: array - items: *379 + items: *375 examples: - default: *380 + default: *376 headers: Link: *58 x-github: @@ -73313,17 +73007,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 responses: '200': description: Response content: application/json: - schema: *381 + schema: *377 examples: - default: *382 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73345,18 +73039,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 responses: '200': description: Response content: application/json: - schema: *379 + schema: *375 examples: - default: *511 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73378,9 +73072,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 requestBody: required: true @@ -73438,9 +73132,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *159 responses: '204': @@ -73466,10 +73160,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *334 - - *335 - - *500 - - *350 + - *330 + - *331 + - *498 + - *346 - *19 responses: '200': @@ -73486,9 +73180,9 @@ paths: type: integer variables: type: array - items: *383 + items: *379 examples: - default: *384 + default: *380 headers: Link: *58 x-github: @@ -73511,9 +73205,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 requestBody: required: true content: @@ -73565,18 +73259,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *334 - - *335 - - *500 + - *330 + - *331 + - *498 - *162 responses: '200': description: Response content: application/json: - schema: *383 + schema: *379 examples: - default: *512 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73597,10 +73291,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 - - *500 + - *498 requestBody: required: true content: @@ -73642,10 +73336,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *334 - - *335 + - *330 + - *331 - *162 - - *500 + - *498 responses: '204': description: Response @@ -73667,8 +73361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -73736,8 +73430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *334 - - *335 + - *330 + - *331 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -73896,8 +73590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -73929,9 +73623,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 '400': *14 '422': *15 '403': *29 @@ -73952,8 +73646,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74013,7 +73707,7 @@ paths: schema: oneOf: - *120 - - *513 + - *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74038,8 +73732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *334 - - *335 + - *330 + - *331 - name: file_sha in: path required: true @@ -74138,8 +73832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74248,7 +73942,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &512 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74462,15 +74156,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *334 - - *335 - - *467 + - *330 + - *331 + - *465 responses: '200': description: Response content: application/json: - schema: *514 + schema: *512 examples: default: value: @@ -74526,9 +74220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *334 - - *335 - - &515 + - *330 + - *331 + - &513 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. @@ -74545,7 +74239,7 @@ paths: application/json: schema: type: array - items: &516 + items: &514 title: Git Reference description: Git references within a repository type: object @@ -74620,17 +74314,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 responses: '200': description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: &517 + default: &515 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -74659,8 +74353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74689,9 +74383,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: *517 + default: *515 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -74717,9 +74411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 requestBody: required: true content: @@ -74748,9 +74442,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: - default: *517 + default: *515 '422': *15 '409': *51 x-github: @@ -74768,9 +74462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *334 - - *335 - - *515 + - *330 + - *331 + - *513 responses: '204': description: Response @@ -74825,8 +74519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -74893,7 +74587,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &517 title: Git Tag description: Metadata for a Git tag type: object @@ -74944,7 +74638,7 @@ paths: - sha - type - url - verification: *518 + verification: *516 required: - sha - url @@ -74954,7 +74648,7 @@ paths: - tag - message examples: - default: &520 + default: &518 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75027,8 +74721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *334 - - *335 + - *330 + - *331 - name: tag_sha in: path required: true @@ -75039,9 +74733,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *517 examples: - default: *520 + default: *518 '404': *6 '409': *51 x-github: @@ -75065,8 +74759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -75139,7 +74833,7 @@ paths: description: Response content: application/json: - schema: &521 + schema: &519 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75235,8 +74929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *334 - - *335 + - *330 + - *331 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75259,7 +74953,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *519 examples: default-response: summary: Default response @@ -75318,8 +75012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -75329,7 +75023,7 @@ paths: application/json: schema: type: array - items: &522 + items: &520 title: Webhook description: Webhooks for repositories. type: object @@ -75457,8 +75151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -75510,9 +75204,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: &523 + default: &521 value: type: Repository id: 12345678 @@ -75560,17 +75254,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '200': description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: *523 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -75590,8 +75284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 requestBody: required: true @@ -75637,9 +75331,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *520 examples: - default: *523 + default: *521 '422': *15 '404': *6 x-github: @@ -75660,8 +75354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75686,8 +75380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '200': @@ -75715,8 +75409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *204 requestBody: required: false @@ -75761,8 +75455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *17 - *205 @@ -75794,8 +75488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *16 responses: @@ -75824,8 +75518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 - *16 responses: @@ -75849,8 +75543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75876,8 +75570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *334 - - *335 + - *330 + - *331 - *204 responses: '204': @@ -75901,8 +75595,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response if immutable releases are enabled @@ -75948,8 +75642,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '409': *51 @@ -75969,8 +75663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '409': *51 @@ -76027,14 +75721,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response content: application/json: - schema: &524 + schema: &522 title: Import description: A repository import from an external source. type: object @@ -76133,7 +75827,7 @@ paths: - html_url - authors_url examples: - default: &527 + default: &525 value: vcs: subversion use_lfs: true @@ -76149,7 +75843,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': &525 + '503': &523 description: Unavailable due to service under maintenance. content: application/json: @@ -76178,8 +75872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -76227,7 +75921,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: default: value: @@ -76252,7 +75946,7 @@ paths: type: string '422': *15 '404': *6 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76280,8 +75974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -76330,7 +76024,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: example-1: summary: Example 1 @@ -76378,7 +76072,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': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76401,12 +76095,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76432,8 +76126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *334 - - *335 + - *330 + - *331 - &697 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -76448,7 +76142,7 @@ paths: application/json: schema: type: array - items: &526 + items: &524 title: Porter Author description: Porter Author type: object @@ -76502,7 +76196,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': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76527,8 +76221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *334 - - *335 + - *330 + - *331 - name: author_id in: path required: true @@ -76558,7 +76252,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *524 examples: default: value: @@ -76571,7 +76265,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76595,8 +76289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76637,7 +76331,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76665,8 +76359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -76693,11 +76387,11 @@ paths: description: Response content: application/json: - schema: *524 + schema: *522 examples: - default: *527 + default: *525 '422': *15 - '503': *525 + '503': *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76720,8 +76414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76729,8 +76423,8 @@ paths: application/json: schema: *22 examples: - default: *528 - '301': *338 + default: *526 + '301': *334 '404': *6 x-github: githubCloudOnly: false @@ -76750,8 +76444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -76764,7 +76458,7 @@ paths: properties: {} additionalProperties: false examples: - default: &530 + default: &528 value: limit: collaborators_only origin: repository @@ -76789,13 +76483,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: application/json: - schema: *529 + schema: *527 examples: default: summary: Example request body @@ -76809,7 +76503,7 @@ paths: application/json: schema: *222 examples: - default: *530 + default: *528 '409': description: Response x-github: @@ -76831,8 +76525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -76855,8 +76549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -76866,7 +76560,7 @@ paths: application/json: schema: type: array - items: *531 + items: *529 examples: default: &690 value: @@ -76999,8 +76693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *334 - - *335 + - *330 + - *331 - *226 requestBody: required: false @@ -77030,7 +76724,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *529 examples: default: value: @@ -77161,8 +76855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *334 - - *335 + - *330 + - *331 - *226 responses: '204': @@ -77194,8 +76888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *334 - - *335 + - *330 + - *331 - 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 @@ -77416,7 +77110,7 @@ paths: state_reason: completed headers: Link: *58 - '301': *338 + '301': *334 '422': *15 '404': *6 x-github: @@ -77445,8 +77139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -77686,7 +77380,7 @@ paths: '422': *15 '503': *112 '404': *6 - '410': *532 + '410': *530 x-github: triggersNotification: true githubCloudOnly: false @@ -77714,8 +77408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *98 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -77736,7 +77430,7 @@ paths: application/json: schema: type: array - items: *533 + items: *531 examples: default: &540 value: @@ -77796,17 +77490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: &534 + default: &532 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -77860,8 +77554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -77884,9 +77578,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: *534 + default: *532 '422': *15 x-github: githubCloudOnly: false @@ -77904,8 +77598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -77926,8 +77620,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -77954,9 +77648,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -77977,8 +77671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -78011,16 +77705,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -78042,10 +77736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - *534 responses: '204': description: Response @@ -78065,8 +77759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -78427,8 +78121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *334 - - *335 + - *330 + - *331 - name: event_id in: path required: true @@ -78631,7 +78325,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *532 + '410': *530 '403': *29 x-github: githubCloudOnly: false @@ -78665,8 +78359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - &539 name: issue_number description: The number that identifies the issue. @@ -78682,9 +78376,9 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '304': *37 x-github: githubCloudOnly: false @@ -78709,8 +78403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -78821,9 +78515,9 @@ paths: '422': *15 '503': *112 '403': *29 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78841,8 +78535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -78887,8 +78581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: content: @@ -78938,8 +78632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: assignee in: path @@ -78980,8 +78674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *81 - *17 @@ -78993,13 +78687,13 @@ paths: application/json: schema: type: array - items: *533 + items: *531 examples: default: *540 headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79028,8 +78722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -79052,16 +78746,16 @@ paths: description: Response content: application/json: - schema: *533 + schema: *531 examples: - default: *534 + default: *532 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -79089,8 +78783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -79106,9 +78800,9 @@ paths: default: *541 headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79136,8 +78830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -79168,9 +78862,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *338 + '301': *334 '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -79201,8 +78895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: issue_id in: path @@ -79218,12 +78912,12 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *532 + '410': *530 x-github: triggersNotification: true githubCloudOnly: false @@ -79249,8 +78943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -79266,9 +78960,9 @@ paths: default: *541 headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79285,8 +78979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80138,7 +79832,7 @@ paths: color: red headers: Link: *58 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80155,8 +79849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80187,9 +79881,9 @@ paths: default: false headers: Link: *58 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80206,8 +79900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80270,9 +79964,9 @@ paths: items: *73 examples: default: *542 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '422': *15 x-github: githubCloudOnly: false @@ -80289,8 +79983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80354,9 +80048,9 @@ paths: items: *73 examples: default: *542 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 '422': *15 x-github: githubCloudOnly: false @@ -80373,15 +80067,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '204': description: Response - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80400,8 +80094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: name in: path @@ -80426,9 +80120,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80448,8 +80142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: false @@ -80478,7 +80172,7 @@ paths: '204': description: Response '403': *29 - '410': *532 + '410': *530 '404': *6 '422': *15 x-github: @@ -80496,8 +80190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '204': @@ -80528,8 +80222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 responses: '200': @@ -80539,9 +80233,9 @@ paths: schema: *74 examples: default: *538 - '301': *338 + '301': *334 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80558,8 +80252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -80586,13 +80280,13 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80610,8 +80304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80644,16 +80338,16 @@ paths: description: Response content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Response content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -80675,10 +80369,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *539 - - *332 + - *534 responses: '204': description: Response @@ -80707,8 +80401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80766,8 +80460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -80784,7 +80478,7 @@ paths: headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80812,8 +80506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80850,7 +80544,7 @@ paths: schema: type: string '403': *29 - '410': *532 + '410': *530 '422': *15 '404': *6 x-github: @@ -80870,8 +80564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 requestBody: required: true @@ -80927,8 +80621,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *334 - - *335 + - *330 + - *331 - *539 - *17 - *19 @@ -81474,7 +81168,7 @@ paths: type: string comments: type: array - items: *465 + items: *461 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -81763,7 +81457,7 @@ paths: headers: Link: *58 '404': *6 - '410': *532 + '410': *530 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81780,8 +81474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -81857,8 +81551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -81930,8 +81624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 - &558 name: key_id description: The unique identifier of the key. @@ -81964,8 +81658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *334 - - *335 + - *330 + - *331 - *558 responses: '204': @@ -81986,8 +81680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -82020,8 +81714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82091,8 +81785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82122,8 +81816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82188,8 +81882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *334 - - *335 + - *330 + - *331 - name: name in: path required: true @@ -82215,8 +81909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -82255,9 +81949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *334 - - *335 - - *438 + - *330 + - *331 + - *434 responses: '200': description: Response @@ -82402,8 +82096,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82468,8 +82162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82503,7 +82197,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *466 + schema: *464 examples: default: *560 '204': @@ -82530,8 +82224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *334 - - *335 + - *330 + - *331 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -82633,8 +82327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -82735,8 +82429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - &563 name: milestone_number description: The number that identifies the milestone. @@ -82768,8 +82462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 requestBody: required: false @@ -82826,8 +82520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 responses: '204': @@ -82849,8 +82543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *334 - - *335 + - *330 + - *331 - *563 - *17 - *19 @@ -82882,8 +82576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 - *564 - *565 - *81 @@ -82923,8 +82617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -82982,8 +82676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -83155,8 +82849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83235,8 +82929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83335,8 +83029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -83362,8 +83056,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -83467,8 +83161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *334 - - *335 + - *330 + - *331 responses: '201': description: Response @@ -83513,8 +83207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -83570,8 +83264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *334 - - *335 + - *330 + - *331 - name: build_id in: path required: true @@ -83604,8 +83298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -83710,8 +83404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 - &572 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -83770,8 +83464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *334 - - *335 + - *330 + - *331 - *572 responses: '204': *183 @@ -83799,8 +83493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -84058,8 +83752,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: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Private vulnerability reporting status @@ -84096,8 +83790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '422': *14 @@ -84118,8 +83812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': *183 '422': *14 @@ -84141,8 +83835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -84174,8 +83868,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -84229,8 +83923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *334 - - *335 + - *330 + - *331 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -84290,7 +83984,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: *575 headers: @@ -84324,8 +84018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -85223,8 +84917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - name: sort in: query required: false @@ -85332,8 +85026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '200': @@ -85417,8 +85111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -85459,8 +85153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *90 responses: '204': @@ -85482,8 +85176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -85510,9 +85204,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -85533,8 +85227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *90 requestBody: required: true @@ -85567,16 +85261,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -85598,10 +85292,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *90 - - *332 + - *534 responses: '204': description: Response @@ -85644,8 +85338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - &581 name: pull_number description: The number that identifies the pull request. @@ -85696,8 +85390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -85764,8 +85458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -85828,7 +85522,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -85836,7 +85530,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -85866,8 +85560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *98 - name: direction @@ -85924,8 +85618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -86119,8 +85813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *90 requestBody: @@ -86230,8 +85924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -86242,7 +85936,7 @@ paths: application/json: schema: type: array - items: *466 + items: *464 examples: default: *583 headers: @@ -86274,8 +85968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -86286,7 +85980,7 @@ paths: application/json: schema: type: array - items: *479 + items: *477 examples: default: value: @@ -86324,8 +86018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *334 - - *335 + - *330 + - *331 - *581 responses: '204': @@ -86349,8 +86043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -86462,8 +86156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 responses: '200': @@ -86539,8 +86233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -86578,7 +86272,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -87114,8 +86808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: true @@ -87150,7 +86844,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -87655,8 +87349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *17 - *19 @@ -87818,8 +87512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -87971,8 +87665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - &585 name: review_id @@ -88047,8 +87741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88135,8 +87829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 responses: @@ -88173,8 +87867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 - *17 @@ -88411,8 +88105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88505,8 +88199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *334 - - *335 + - *330 + - *331 - *581 - *585 requestBody: @@ -88567,8 +88261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *334 - - *335 + - *330 + - *331 - *581 requestBody: required: false @@ -88632,8 +88326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *334 - - *335 + - *330 + - *331 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -88690,8 +88384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *334 - - *335 + - *330 + - *331 - name: dir description: The alternate path to look for a README file in: path @@ -88735,8 +88429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -88840,8 +88534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -89024,8 +88718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - &592 name: asset_id description: The unique identifier of the asset. @@ -89075,7 +88769,7 @@ paths: type: User site_admin: false '404': *6 - '302': *481 + '302': *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89091,8 +88785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - *592 requestBody: required: false @@ -89139,8 +88833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *334 - - *335 + - *330 + - *331 - *592 responses: '204': @@ -89165,8 +88859,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -89251,8 +88945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -89277,8 +88971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *334 - - *335 + - *330 + - *331 - name: tag description: tag parameter in: path @@ -89315,8 +89009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *334 - - *335 + - *330 + - *331 - &595 name: release_id description: The unique identifier of the release. @@ -89351,8 +89045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 requestBody: required: false @@ -89440,8 +89134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 responses: '204': @@ -89462,8 +89156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *334 - - *335 + - *330 + - *331 - *595 - *17 - *19 @@ -89555,8 +89249,8 @@ 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: - - *334 - - *335 + - *330 + - *331 - *595 - name: name in: query @@ -89638,8 +89332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -89664,9 +89358,9 @@ paths: application/json: schema: type: array - items: *329 + items: *462 examples: - default: *331 + default: *533 headers: Link: *58 '404': *6 @@ -89687,8 +89381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *334 - - *335 + - *330 + - *331 - *595 requestBody: required: true @@ -89719,16 +89413,16 @@ paths: description: Reaction exists content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '201': description: Reaction created content: application/json: - schema: *329 + schema: *462 examples: - default: *330 + default: *463 '422': *15 x-github: githubCloudOnly: false @@ -89750,10 +89444,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *334 - - *335 + - *330 + - *331 - *595 - - *332 + - *534 responses: '204': description: Response @@ -89777,9 +89471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *334 - - *335 - - *401 + - *330 + - *331 + - *397 - *17 - *19 responses: @@ -89916,8 +89610,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - name: includes_parents @@ -89983,8 +89677,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 requestBody: description: Request body required: true @@ -90093,8 +89787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *334 - - *335 + - *330 + - *331 - *600 - *601 - *602 @@ -90129,8 +89823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *334 - - *335 + - *330 + - *331 - *606 responses: '200': @@ -90167,8 +89861,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90208,8 +89902,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90291,8 +89985,8 @@ paths: category: repos subcategory: rules parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90315,8 +90009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 - name: ruleset_id @@ -90353,8 +90047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *334 - - *335 + - *330 + - *331 - name: ruleset_id description: The ID of the ruleset. in: path @@ -90427,8 +90121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 - *612 - *613 - *614 @@ -90715,9 +90409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *622 responses: '200': @@ -90778,9 +90472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 requestBody: required: true content: @@ -90918,9 +90612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *334 - - *335 - - *432 + - *330 + - *331 + - *428 - *19 - *17 responses: @@ -91055,8 +90749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91134,8 +90828,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: - - *334 - - *335 + - *330 + - *331 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -91254,8 +90948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *334 - - *335 + - *330 + - *331 - *52 - name: sort description: The property to sort the results by. @@ -91324,8 +91018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91720,8 +91414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -91972,8 +91666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '200': @@ -92006,8 +91700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 requestBody: required: true @@ -92208,8 +91902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '202': *39 @@ -92237,17 +91931,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *334 - - *335 + - *330 + - *331 - *645 responses: '202': description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 '400': *14 '422': *15 '403': *29 @@ -92273,8 +91967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -92373,8 +92067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -92416,8 +92110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -92493,8 +92187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -92590,8 +92284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -92745,8 +92439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -92789,8 +92483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *334 - - *335 + - *330 + - *331 - name: sha in: path required: true @@ -92898,8 +92592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -92931,8 +92625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: if you subscribe to the repository @@ -93006,8 +92700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -93060,8 +92754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -93081,8 +92775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -93161,8 +92855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93222,8 +92916,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: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -93277,8 +92971,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: - - *334 - - *335 + - *330 + - *331 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -93315,8 +93009,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *334 - - *335 + - *330 + - *331 - name: ref in: path required: true @@ -93352,8 +93046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *334 - - *335 + - *330 + - *331 - *17 - *19 responses: @@ -93385,8 +93079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *334 - - *335 + - *330 + - *331 - *19 - *17 responses: @@ -93429,8 +93123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -93484,8 +93178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *334 - - *335 + - *330 + - *331 - &653 name: per description: The time frame to display results for. @@ -93603,8 +93297,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93695,8 +93389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *334 - - *335 + - *330 + - *331 responses: '200': description: Response @@ -93757,8 +93451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *334 - - *335 + - *330 + - *331 - *653 responses: '200': @@ -93856,8 +93550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *334 - - *335 + - *330 + - *331 requestBody: required: true content: @@ -94131,8 +93825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -94155,8 +93849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -94178,8 +93872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -94205,8 +93899,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *334 - - *335 + - *330 + - *331 - name: ref in: path required: true @@ -94298,9 +93992,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -94781,7 +94475,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true comment_count: type: integer @@ -94801,7 +94495,7 @@ paths: url: type: string format: uri - verification: *518 + verification: *516 required: - author - committer @@ -94820,7 +94514,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *399 + properties: *395 nullable: true parents: type: array @@ -97017,246 +96711,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - *660 - - *325 - - *328 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - *660 - - *325 - - *328 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - *660 - - *325 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *331 - headers: - Link: *58 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - *660 - - *325 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *329 - examples: - default: *330 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -97482,7 +96936,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-user-is-a-team-maintainer: *665 '404': *6 @@ -97543,7 +96997,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *329 examples: response-if-users-membership-with-team-is-now-pending: *666 '403': @@ -97650,8 +97104,8 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 responses: '200': description: Alternative response with extra repository information @@ -97809,8 +97263,8 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 requestBody: required: false content: @@ -97861,8 +97315,8 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *660 - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -98634,7 +98088,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -98642,7 +98096,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -98726,7 +98180,7 @@ paths: - visibility - selected_repositories_url examples: - default: *458 + default: *454 headers: Link: *58 x-github: @@ -99100,7 +98554,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '304': *37 '500': *111 '401': *25 @@ -99158,7 +98612,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '401': *25 '403': *29 '404': *6 @@ -99421,13 +98875,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *337 + repository: *333 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *456 - required: *457 + properties: *452 + required: *453 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -100209,7 +99663,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '304': *37 '500': *111 '400': *14 @@ -100249,7 +99703,7 @@ paths: application/json: schema: *232 examples: - default: *455 + default: *451 '500': *111 '401': *25 '403': *29 @@ -101397,7 +100851,7 @@ paths: required: true content: application/json: - schema: *529 + schema: *527 examples: default: value: @@ -103826,9 +103280,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *333 examples: - default: *339 + default: *335 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -103866,7 +103320,7 @@ paths: application/json: schema: type: array - items: *531 + items: *529 examples: default: *690 headers: @@ -104480,8 +103934,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: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response if this repository is starred by you @@ -104509,8 +103963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -104534,8 +103988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *334 - - *335 + - *330 + - *331 responses: '204': description: Response @@ -105215,7 +104669,7 @@ paths: initiator: type: string examples: - default: *395 + default: *391 '201': description: Response content: @@ -105746,7 +105200,7 @@ paths: application/json: schema: *22 examples: - default: *528 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113056,7 +112510,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113379,7 +112833,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113709,7 +113163,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114051,7 +113505,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114321,7 +113775,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114602,7 +114056,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114913,7 +114367,7 @@ x-webhooks: required: - login - id - dismissed_comment: *427 + dismissed_comment: *423 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116012,7 +115466,7 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116100,7 +115554,7 @@ x-webhooks: type: string enum: - auto_reopened - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116188,7 +115642,7 @@ x-webhooks: type: string enum: - created - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116274,7 +115728,7 @@ x-webhooks: type: string enum: - dismissed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116360,7 +115814,7 @@ x-webhooks: type: string enum: - fixed - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116447,7 +115901,7 @@ x-webhooks: type: string enum: - reintroduced - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -116533,7 +115987,7 @@ x-webhooks: type: string enum: - reopened - alert: *487 + alert: *485 installation: *725 organization: *726 enterprise: *724 @@ -118026,7 +117480,7 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *493 + deployment: *491 pull_requests: type: array items: *579 @@ -220173,7 +219627,7 @@ x-webhooks: enterprise: *724 installation: *725 organization: *726 - repository: *337 + repository: *333 sender: *4 required: - changes @@ -225396,7 +224850,7 @@ x-webhooks: type: string required: - conclusion - deployment: *493 + deployment: *491 required: - action - repository @@ -225738,7 +225192,7 @@ x-webhooks: required: - status - steps - deployment: *493 + deployment: *491 required: - action - repository @@ -225955,7 +225409,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *493 + deployment: *491 required: - action - repository @@ -226173,7 +225627,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *493 + deployment: *491 required: - action - repository diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index f98a62623..3cfc84009 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -252815,17 +252815,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-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/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -252845,61 +252845,6 @@ "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" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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": { @@ -252908,236 +252853,92 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "example": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ], + "type": "array", + "items": { "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], "properties": { - "name": { - "nullable": true, - "type": "string" + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "email": { - "nullable": true, + "group_name": { + "description": "The display name of the group", + "example": "group-azuread-test", "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "updated_at": { + "description": "The time of the last update for this group", + "example": "2019-06-03 22:27:15:000 -700", + "type": "string" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "external-groups" } }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -253157,24 +252958,6 @@ "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": { @@ -253184,29 +252967,20 @@ "schema": { "type": "object", "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "group_id": { + "type": "integer", + "description": "External Group Id", + "example": 1 } }, "required": [ - "content" + "group_id" ] }, "examples": { "default": { "value": { - "content": "heart" + "group_id": 123 } } } @@ -253215,407 +252989,149 @@ }, "responses": { "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], "properties": { - "id": { - "type": "integer", - "example": 1 + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "group_name": { + "description": "The display name for the group", + "example": "group-azuread-test", + "type": "string" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "updated_at": { + "description": "The date when the group was last updated_at", + "example": "2021-01-03 22:27:15:000 -700", + "type": "string" + }, + "teams": { + "description": "An array of teams linked to this group", + "example": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "example": 1, + "type": "integer" + }, + "team_name": { + "description": "The name of the team", + "example": "team-test", + "type": "string" + } + } + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "members": { + "description": "An array of external members linked to this group", + "example": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "example": 1, + "type": "integer" + }, + "member_login": { + "description": "The handle/login for the user", + "example": "mona-lisa_eocsaxrs", + "type": "string" + }, + "member_name": { + "description": "The user display name/profile name", + "example": "Mona Lisa", + "type": "string" + }, + "member_email": { + "description": "An email attached to a user", + "example": "mona_lisa@github.com", + "type": "string" + } + } + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "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" + } ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" } } } @@ -253624,24 +253140,22 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + }, "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -253661,33 +253175,6 @@ "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" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -253696,24 +253183,24 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/invitations": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`.\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 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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -253734,34 +253221,6 @@ "type": "string" } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -253789,19 +253248,37 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Organization Invitation", + "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64" }, - "node_id": { + "login": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "nullable": true }, - "user": { + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -253923,36 +253400,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -253961,29 +253436,36 @@ "value": [ { "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "login": "octocat", - "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -254003,20 +253485,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" }, "parameters": [ { @@ -254038,229 +253522,175 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "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": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -254279,215 +253709,17 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } + } + ] } } } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } + "type": "string" } } } @@ -254495,23 +253727,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -254533,62 +253765,8 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/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.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -254602,92 +253780,73 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", + "title": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "example": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name of the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The time of the last update for this group", - "example": "2019-06-03 22:27:15:000 -700", - "type": "string" - } - } - } + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } - } + }, + "required": [ + "role", + "state", + "url" + ] }, "examples": { - "default": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", "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" - } - ] + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" } } } } } + }, + "404": { + "description": "if user has no team membership" } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "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/link-external-idp-group-to-team-for-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/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -254707,29 +253866,40 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "example": 1 + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" } - }, - "required": [ - "group_id" - ] + } }, "examples": { "default": { + "summary": "Add or update team membership for an organization member", "value": { - "group_id": 123 + "role": "maintainer" } } } @@ -254742,995 +253912,76 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", + "title": "Team Membership", + "description": "Team Membership", "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name for the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "example": "2021-01-03 22:27:15:000 -700", - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "teams": { - "description": "An array of teams linked to this group", - "example": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "example": 1, - "type": "integer" - }, - "team_name": { - "description": "The name of the team", - "example": "team-test", - "type": "string" - } - } - } + "default": "member", + "example": "member", + "type": "string" }, - "members": { - "description": "An array of external members linked to this group", - "example": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ], - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "example": 1, - "type": "integer" - }, - "member_login": { - "description": "The handle/login for the user", - "example": "mona-lisa_eocsaxrs", - "type": "string" - }, - "member_name": { - "description": "The user display name/profile name", - "example": "Mona Lisa", - "type": "string" - }, - "member_email": { - "description": "An email attached to a user", - "example": "mona_lisa@github.com", - "type": "string" - } - } - } + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } - } + }, + "required": [ + "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": { - "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" - } - ] + "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": true, - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, "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.", + "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/unlink-external-idp-group-from-team-for-org", + "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#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", - "nullable": true - }, - "email": { - "type": "string", - "nullable": true - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": "string", - "nullable": true - }, - "failed_reason": { - "type": "string", - "nullable": true - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - }, - "invitation_teams_url": { - "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" - }, - "invitation_source": { - "type": "string", - "example": "\"member\"" - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/members": { - "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "tags": [ - "teams" - ], - "operationId": "teams/list-members-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - } - } - } - } - }, - "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role that this user should have in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -597794,2422 +596045,670 @@ "type": "string", "example": "MDQ6VGVhbTE=" }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/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", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions": { - "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/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-discussions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "post": { - "summary": "Create a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - }, - "private": { - "type": "boolean", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "default": false - } - }, - "required": [ - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -600218,20 +596717,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": [ { @@ -600242,20 +596741,106 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -600264,22 +596849,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": [ { @@ -600291,15 +596876,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.", @@ -600341,8 +596917,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": { @@ -600471,57 +597047,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -600578,12 +597178,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -600613,19 +597218,24 @@ "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", + "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, - "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, @@ -600658,20 +597268,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": [ { @@ -600682,15 +597292,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -600700,19 +597301,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." } } } @@ -600725,8 +597337,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": { @@ -600855,57 +597467,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -600962,12 +597598,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -600995,19 +597636,24 @@ "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", + "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, - "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, @@ -601032,22 +597678,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": [ { @@ -601067,15 +597713,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -601084,8 +597721,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": { @@ -601214,57 +597851,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -601321,12 +597982,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -601354,19 +598020,24 @@ "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", + "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, - "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, @@ -601390,20 +598061,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": [ { @@ -601423,37 +598094,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" } } } @@ -601466,8 +598129,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": { @@ -601596,57 +598259,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -601703,12 +598390,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -601736,19 +598428,24 @@ "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", + "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", - "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, @@ -601772,20 +598469,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": [ { @@ -601805,15 +598502,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -601827,22 +598515,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}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", + "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -601864,31 +598552,17 @@ } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -601918,19 +598592,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602055,33 +598721,122 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] } }, @@ -602089,9 +598844,7 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602111,8 +598864,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -602132,23 +598906,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -602168,15 +598942,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -602186,29 +598951,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like apples?" } } } @@ -602221,19 +598976,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602358,41 +599105,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602412,8 +599246,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -602422,27 +599277,28 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-legacy", + "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -602464,40 +599320,12 @@ } }, { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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", + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -602507,239 +599335,326 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "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": [ - { + "value": { + "author": { + "login": "octocat", "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-legacy", + "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -602759,6 +599674,15 @@ "schema": { "type": "integer" } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -602768,29 +599692,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like pineapples?" } } } @@ -602798,24 +599712,16 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602940,41 +599846,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602994,8 +599987,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -603005,11 +600019,66 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "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": [ + { + "name": "team_id", + "description": "The unique identifier of the team.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "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, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 8083f5d1e..0d22fd19a 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -13108,7 +13108,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &540 + instances_url: &536 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13143,7 +13143,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &541 + dismissed_reason: &537 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -13152,13 +13152,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &542 + dismissed_comment: &538 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &543 + rule: &539 type: object properties: id: @@ -13211,7 +13211,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &544 + tool: &540 type: object properties: name: *111 @@ -13221,26 +13221,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &545 + most_recent_instance: &541 type: object properties: - ref: &538 + ref: &534 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &555 + analysis_key: &551 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: &556 + environment: &552 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: &557 + category: &553 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13254,7 +13254,7 @@ paths: properties: text: type: string - location: &558 + location: &554 type: object description: Describe a region within a file for the alert. properties: @@ -13275,7 +13275,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &559 + items: &555 type: string description: A classification of the file. For example to identify it as generated. @@ -16938,7 +16938,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &598 + - &596 name: has in: query description: |- @@ -17051,7 +17051,7 @@ paths: - unknown - direct - transitive - security_advisory: &599 + security_advisory: &597 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17283,14 +17283,14 @@ paths: nullable: true maxLength: 280 fixed_at: *137 - auto_dismissed_at: &600 + auto_dismissed_at: &598 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &601 + dismissal_request: &599 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -25885,7 +25885,7 @@ paths: action: type: string issue: *220 - comment: &658 + comment: &656 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -30559,14 +30559,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &466 + - &462 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &467 + - &463 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -30628,7 +30628,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &472 + '301': &468 description: Moved permanently content: application/json: @@ -33130,7 +33130,7 @@ paths: type: integer repository_cache_usages: type: array - items: &479 + items: &475 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -36286,7 +36286,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &495 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -36315,7 +36315,7 @@ paths: - key_id - key examples: - default: &500 + default: &496 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -36728,7 +36728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *87 - - &484 + - &480 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)." @@ -38348,7 +38348,7 @@ paths: initiator: type: string examples: - default: &513 + default: &509 value: attestations: - bundle: @@ -39265,7 +39265,7 @@ paths: be returned. in: query required: false - schema: &539 + schema: &535 type: string description: Severity of a code scanning alert. enum: @@ -40319,7 +40319,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &571 + properties: &567 name: type: string description: The name of the machine. @@ -40361,7 +40361,7 @@ paths: - ready - in_progress nullable: true - required: &572 + required: &568 - name - display_name - operating_system @@ -41229,7 +41229,7 @@ paths: - updated_at - visibility examples: - default: &573 + default: &569 value: total_count: 2 secrets: @@ -41267,7 +41267,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &570 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -41296,7 +41296,7 @@ paths: - key_id - key examples: - default: &575 + default: &571 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41328,7 +41328,7 @@ paths: application/json: schema: *327 examples: - default: &577 + default: &573 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -43187,7 +43187,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &602 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -43204,7 +43204,7 @@ paths: - key_id - key examples: - default: &605 + default: &603 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -43534,7 +43534,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &613 + - &611 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -43542,7 +43542,7 @@ paths: required: false schema: type: string - - &614 + - &612 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -43550,7 +43550,7 @@ paths: required: false schema: type: string - - &615 + - &613 name: time_period description: |- The time period to filter by. @@ -43566,7 +43566,7 @@ paths: - week - month default: month - - &616 + - &614 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -43591,7 +43591,7 @@ paths: application/json: schema: type: array - items: &617 + items: &615 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -43747,7 +43747,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &618 + default: &616 value: - id: 21 number: 42 @@ -43865,7 +43865,7 @@ paths: application/json: schema: type: array - items: &619 + items: &617 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -43982,7 +43982,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &620 + default: &618 value: - id: 21 number: 42 @@ -44084,7 +44084,7 @@ paths: application/json: schema: type: array - items: &621 + items: &619 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -44205,7 +44205,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &622 + default: &620 value: - id: 21 number: 42 @@ -44550,7 +44550,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &459 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -44631,7 +44631,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &464 + default: &460 value: group_id: '123' group_name: Octocat admins @@ -44686,7 +44686,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &457 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -44723,7 +44723,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &462 + default: &458 value: groups: - group_id: '123' @@ -46025,7 +46025,7 @@ paths: application/json: schema: *22 examples: - default: &653 + default: &651 value: id: 1 account: @@ -46250,7 +46250,7 @@ paths: required: true content: application/json: - schema: &654 + schema: &652 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -47111,7 +47111,7 @@ paths: application/json: schema: *376 examples: - default: &570 + default: &566 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -51781,7 +51781,7 @@ paths: content: oneOf: - *220 - - &585 + - &583 title: Pull Request Simple description: Pull Request Simple type: object @@ -54650,7 +54650,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &467 title: Full Repository description: Full Repository type: object @@ -55043,7 +55043,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &590 + properties: &588 url: type: string format: uri @@ -55059,7 +55059,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &591 + required: &589 - url - key - name @@ -55148,7 +55148,7 @@ paths: - network_count - subscribers_count examples: - default: &473 + default: &469 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -58024,7 +58024,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &464 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -58070,7 +58070,7 @@ paths: type: string nullable: true examples: - default: &469 + default: &465 value: groups: - group_id: '123' @@ -59679,407 +59679,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - *87 - - *215 - - *453 - - *456 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &457 - title: Reaction - description: Reactions to conversations provide a way to help people - express their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &459 - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - *87 - - *215 - - *453 - - *456 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: *457 - examples: - default: &458 - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - *87 - - *215 - - *453 - - *456 - - &460 - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - *87 - - *215 - - *453 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - *87 - - *215 - - *453 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - *87 - - *215 - - *453 - - *460 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/external-groups": get: summary: List a connection between an external group and a team @@ -60101,9 +59700,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *457 examples: - default: *462 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60146,9 +59745,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *459 examples: - default: *464 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60289,7 +59888,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &461 title: Team Membership description: Team Membership type: object @@ -60379,7 +59978,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-users-membership-with-team-is-now-pending: &805 summary: Response if user's membership with team is now pending @@ -60488,8 +60087,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Alternative response with repository permissions @@ -61066,8 +60665,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -61114,8 +60713,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -61148,9 +60747,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61216,7 +60815,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: default: value: @@ -61415,7 +61014,7 @@ paths: resources: type: object properties: - core: &470 + core: &466 title: Rate Limit type: object properties: @@ -61432,21 +61031,21 @@ paths: - remaining - reset - used - graphql: *470 - search: *470 - code_search: *470 - source_import: *470 - integration_manifest: *470 - code_scanning_upload: *470 - actions_runner_registration: *470 - scim: *470 - dependency_snapshots: *470 - dependency_sbom: *470 - code_scanning_autofix: *470 + graphql: *466 + search: *466 + code_search: *466 + source_import: *466 + integration_manifest: *466 + code_scanning_upload: *466 + actions_runner_registration: *466 + scim: *466 + dependency_snapshots: *466 + dependency_sbom: *466 + code_scanning_autofix: *466 required: - core - search - rate: *470 + rate: *466 required: - rate - resources @@ -61551,14 +61150,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: default-response: summary: Default response @@ -62063,7 +61662,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *472 + '301': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62081,8 +61680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -62339,10 +61938,10 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 - '307': &474 + default: *469 + '307': &470 description: Temporary Redirect content: application/json: @@ -62371,8 +61970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -62394,7 +61993,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': *474 + '307': *470 '404': *6 '409': *118 x-github: @@ -62418,11 +62017,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - - &491 + - &487 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62445,7 +62044,7 @@ paths: type: integer artifacts: type: array - items: &475 + items: &471 title: Artifact description: An artifact type: object @@ -62523,7 +62122,7 @@ paths: - expires_at - updated_at examples: - default: &492 + default: &488 value: total_count: 2 artifacts: @@ -62584,9 +62183,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *466 - - *467 - - &476 + - *462 + - *463 + - &472 name: artifact_id description: The unique identifier of the artifact. in: path @@ -62598,7 +62197,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *471 examples: default: value: @@ -62636,9 +62235,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *466 - - *467 - - *476 + - *462 + - *463 + - *472 responses: '204': description: Response @@ -62662,9 +62261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *466 - - *467 - - *476 + - *462 + - *463 + - *472 - name: archive_format in: path required: true @@ -62678,7 +62277,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': &657 + '410': &655 description: Gone content: application/json: @@ -62703,14 +62302,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &477 + schema: &473 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -62743,13 +62342,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *477 + schema: *473 examples: selected_actions: *44 responses: @@ -62778,14 +62377,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &478 + schema: &474 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -62818,13 +62417,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *478 + schema: *474 examples: selected_actions: *46 responses: @@ -62855,14 +62454,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: default: value: @@ -62888,11 +62487,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: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - - &480 + - &476 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 @@ -62926,7 +62525,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &477 title: Repository actions caches description: Repository actions caches type: object @@ -62968,7 +62567,7 @@ paths: - total_count - actions_caches examples: - default: &482 + default: &478 value: total_count: 1 actions_caches: @@ -63000,23 +62599,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: - - *466 - - *467 + - *462 + - *463 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *480 + - *476 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63036,8 +62635,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: - - *466 - - *467 + - *462 + - *463 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63068,9 +62667,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: - - *466 - - *467 - - &483 + - *462 + - *463 + - &479 name: job_id description: The unique identifier of the job. in: path @@ -63082,7 +62681,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &491 title: Job description: Information of a job execution in a workflow run type: object @@ -63389,9 +62988,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: - - *466 - - *467 - - *483 + - *462 + - *463 + - *479 responses: '302': description: Response @@ -63419,9 +63018,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: - - *466 - - *467 - - *483 + - *462 + - *463 + - *479 requestBody: required: false content: @@ -63466,8 +63065,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Status response @@ -63517,8 +63116,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -63581,8 +63180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -63600,7 +63199,7 @@ paths: type: integer secrets: type: array - items: &497 + items: &493 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63620,7 +63219,7 @@ paths: - created_at - updated_at examples: - default: &498 + default: &494 value: total_count: 2 secrets: @@ -63653,9 +63252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *466 - - *467 - - *484 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -63672,7 +63271,7 @@ paths: type: integer variables: type: array - items: &501 + items: &497 title: Actions Variable type: object properties: @@ -63702,7 +63301,7 @@ paths: - created_at - updated_at examples: - default: &502 + default: &498 value: total_count: 2 variables: @@ -63735,8 +63334,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -63745,7 +63344,7 @@ paths: schema: type: object properties: - enabled: &485 + enabled: &481 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -63780,8 +63379,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -63792,7 +63391,7 @@ paths: schema: type: object properties: - enabled: *485 + enabled: *481 allowed_actions: *60 sha_pinning_required: *61 required: @@ -63825,14 +63424,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &486 + schema: &482 type: object properties: access_level: @@ -63850,7 +63449,7 @@ paths: required: - access_level examples: - default: &487 + default: &483 value: access_level: organization x-github: @@ -63875,15 +63474,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *486 + schema: *482 examples: - default: *487 + default: *483 responses: '204': description: Response @@ -63907,8 +63506,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -63938,8 +63537,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Empty response for successful settings update @@ -63973,8 +63572,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64001,8 +63600,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -64036,8 +63635,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64065,8 +63664,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -64097,8 +63696,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64129,8 +63728,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -64162,8 +63761,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64192,8 +63791,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Success response @@ -64233,8 +63832,8 @@ paths: in: query schema: type: string - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -64278,8 +63877,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64311,8 +63910,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -64386,8 +63985,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: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -64423,8 +64022,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: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -64454,8 +64053,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': @@ -64485,8 +64084,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '204': @@ -64513,8 +64112,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': *81 @@ -64539,8 +64138,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: - - *466 - - *467 + - *462 + - *463 - *75 requestBody: required: true @@ -64589,8 +64188,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: - - *466 - - *467 + - *462 + - *463 - *75 requestBody: required: true @@ -64640,8 +64239,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': *290 @@ -64671,8 +64270,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: - - *466 - - *467 + - *462 + - *463 - *75 - *291 responses: @@ -64702,9 +64301,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: - - *466 - - *467 - - &505 + - *462 + - *463 + - &501 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. @@ -64712,7 +64311,7 @@ paths: required: false schema: type: string - - &506 + - &502 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -64720,7 +64319,7 @@ paths: required: false schema: type: string - - &507 + - &503 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -64729,7 +64328,7 @@ paths: required: false schema: type: string - - &508 + - &504 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 @@ -64756,7 +64355,7 @@ paths: - pending - *17 - *19 - - &509 + - &505 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)." @@ -64765,7 +64364,7 @@ paths: schema: type: string format: date-time - - &488 + - &484 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -64774,13 +64373,13 @@ paths: schema: type: boolean default: false - - &510 + - &506 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &511 + - &507 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -64803,7 +64402,7 @@ paths: type: integer workflow_runs: type: array - items: &489 + items: &485 title: Workflow Run description: An invocation of a workflow type: object @@ -64951,7 +64550,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &533 + properties: &529 id: type: string description: SHA for the commit @@ -65002,7 +64601,7 @@ paths: - name - email nullable: true - required: &534 + required: &530 - id - tree_id - message @@ -65049,7 +64648,7 @@ paths: - workflow_url - pull_requests examples: - default: &512 + default: &508 value: total_count: 1 workflow_runs: @@ -65285,24 +64884,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *466 - - *467 - - &490 + - *462 + - *463 + - &486 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *488 + - *484 responses: '200': description: Response content: application/json: - schema: *489 + schema: *485 examples: - default: &493 + default: &489 value: id: 30433642 name: Build @@ -65543,9 +65142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -65568,9 +65167,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65689,9 +65288,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '201': description: Response @@ -65724,12 +65323,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 - *17 - *19 - - *491 + - *487 responses: '200': description: Response @@ -65745,9 +65344,9 @@ paths: type: integer artifacts: type: array - items: *475 + items: *471 examples: - default: *492 + default: *488 headers: Link: *47 x-github: @@ -65771,25 +65370,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *466 - - *467 - - *490 - - &494 + - *462 + - *463 + - *486 + - &490 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *488 + - *484 responses: '200': description: Response content: application/json: - schema: *489 + schema: *485 examples: - default: *493 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65812,10 +65411,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: - - *466 - - *467 + - *462 + - *463 + - *486 - *490 - - *494 - *17 - *19 responses: @@ -65833,9 +65432,9 @@ paths: type: integer jobs: type: array - items: *495 + items: *491 examples: - default: &496 + default: &492 value: total_count: 1 jobs: @@ -65948,10 +65547,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *466 - - *467 + - *462 + - *463 + - *486 - *490 - - *494 responses: '302': description: Response @@ -65979,9 +65578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '202': description: Response @@ -66014,9 +65613,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -66083,9 +65682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '202': description: Response @@ -66118,9 +65717,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 - 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 @@ -66150,9 +65749,9 @@ paths: type: integer jobs: type: array - items: *495 + items: *491 examples: - default: *496 + default: *492 headers: Link: *47 x-github: @@ -66177,9 +65776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '302': description: Response @@ -66206,9 +65805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -66235,9 +65834,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -66297,7 +65896,7 @@ paths: items: type: object properties: - type: &623 + type: &621 type: string description: The type of reviewer. enum: @@ -66382,9 +65981,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -66431,7 +66030,7 @@ paths: application/json: schema: type: array - items: &608 + items: &606 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -66537,7 +66136,7 @@ paths: - created_at - updated_at examples: - default: &609 + default: &607 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -66593,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -66639,9 +66238,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -66695,9 +66294,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -66834,8 +66433,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -66853,9 +66452,9 @@ paths: type: integer secrets: type: array - items: *497 + items: *493 examples: - default: *498 + default: *494 headers: Link: *47 x-github: @@ -66880,16 +66479,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *499 + schema: *495 examples: - default: *500 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66911,17 +66510,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *497 + schema: *493 examples: - default: &636 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -66947,8 +66546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -67006,8 +66605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -67033,9 +66632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *466 - - *467 - - *484 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -67052,9 +66651,9 @@ paths: type: integer variables: type: array - items: *501 + items: *497 examples: - default: *502 + default: *498 headers: Link: *47 x-github: @@ -67077,8 +66676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -67130,17 +66729,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 responses: '200': description: Response content: application/json: - schema: *501 + schema: *497 examples: - default: &637 + default: &635 value: name: USERNAME value: octocat @@ -67166,8 +66765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 requestBody: required: true @@ -67210,8 +66809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 responses: '204': @@ -67237,8 +66836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -67256,7 +66855,7 @@ paths: type: integer workflows: type: array - items: &503 + items: &499 title: Workflow description: A GitHub Actions workflow type: object @@ -67363,9 +66962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *466 - - *467 - - &504 + - *462 + - *463 + - &500 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67380,7 +66979,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *499 examples: default: value: @@ -67413,9 +67012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67440,9 +67039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67493,9 +67092,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67522,19 +67121,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: - - *466 - - *467 + - *462 + - *463 + - *500 + - *501 + - *502 + - *503 - *504 + - *17 + - *19 - *505 + - *484 - *506 - *507 - - *508 - - *17 - - *19 - - *509 - - *488 - - *510 - - *511 responses: '200': description: Response @@ -67550,9 +67149,9 @@ paths: type: integer workflow_runs: type: array - items: *489 + items: *485 examples: - default: *512 + default: *508 headers: Link: *47 x-github: @@ -67585,9 +67184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '200': description: Response @@ -67648,8 +67247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *466 - - *467 + - *462 + - *463 - *110 - *17 - *108 @@ -67813,8 +67412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -67851,8 +67450,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: - - *466 - - *467 + - *462 + - *463 - name: assignee in: path required: true @@ -67888,8 +67487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -68001,8 +67600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *108 - *109 @@ -68059,7 +67658,7 @@ paths: initiator: type: string examples: - default: *513 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68079,8 +67678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -68088,7 +67687,7 @@ paths: application/json: schema: type: array - items: &514 + items: &510 title: Autolink reference description: An autolink reference. type: object @@ -68142,8 +67741,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -68182,9 +67781,9 @@ paths: description: response content: application/json: - schema: *514 + schema: *510 examples: - default: &515 + default: &511 value: id: 1 key_prefix: TICKET- @@ -68215,9 +67814,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: - - *466 - - *467 - - &516 + - *462 + - *463 + - &512 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68229,9 +67828,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *510 examples: - default: *515 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -68251,9 +67850,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: - - *466 - - *467 - - *516 + - *462 + - *463 + - *512 responses: '204': description: Response @@ -68277,8 +67876,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response if Dependabot is enabled @@ -68326,8 +67925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -68348,8 +67947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -68369,8 +67968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *466 - - *467 + - *462 + - *463 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68408,7 +68007,7 @@ paths: - url protected: type: boolean - protection: &518 + protection: &514 title: Branch Protection description: Branch Protection type: object @@ -68450,7 +68049,7 @@ paths: required: - contexts - checks - enforce_admins: &521 + enforce_admins: &517 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -68465,7 +68064,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &523 + required_pull_request_reviews: &519 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -68541,7 +68140,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &520 + restrictions: &516 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -68818,9 +68417,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *466 - - *467 - - &519 + - *462 + - *463 + - &515 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). @@ -68834,14 +68433,14 @@ paths: description: Response content: application/json: - schema: &529 + schema: &525 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &581 + commit: &579 title: Commit description: Commit type: object @@ -68875,7 +68474,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &517 + properties: &513 name: type: string example: '"Chris Wanstrath"' @@ -68891,7 +68490,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true message: type: string @@ -68912,7 +68511,7 @@ paths: required: - sha - url - verification: &643 + verification: &641 title: Verification type: object properties: @@ -68982,7 +68581,7 @@ paths: type: integer files: type: array - items: &594 + items: &592 title: Diff Entry description: Diff Entry type: object @@ -69066,7 +68665,7 @@ paths: - self protected: type: boolean - protection: *518 + protection: *514 protection_url: type: string format: uri @@ -69173,7 +68772,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *472 + '301': *468 '404': *6 x-github: githubCloudOnly: false @@ -69195,15 +68794,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *518 + schema: *514 examples: default: value: @@ -69397,9 +68996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69654,7 +69253,7 @@ paths: url: type: string format: uri - required_status_checks: &526 + required_status_checks: &522 title: Status Check Policy description: Status Check Policy type: object @@ -69806,7 +69405,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *520 + restrictions: *516 required_conversation_resolution: type: object properties: @@ -69918,9 +69517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69945,17 +69544,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: &522 + default: &518 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -69977,17 +69576,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: *522 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70006,9 +69605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70033,17 +69632,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *523 + schema: *519 examples: - default: &524 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70139,9 +69738,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70239,9 +69838,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *519 examples: - default: *524 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -70262,9 +69861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70291,17 +69890,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: &525 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70324,17 +69923,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: *525 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -70354,9 +69953,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70381,17 +69980,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *526 + schema: *522 examples: - default: &527 + default: &523 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -70417,9 +70016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70471,9 +70070,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *522 examples: - default: *527 + default: *523 '404': *6 '422': *15 x-github: @@ -70495,9 +70094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70521,9 +70120,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70557,9 +70156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70626,9 +70225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70692,9 +70291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -70760,15 +70359,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *520 + schema: *516 examples: default: value: @@ -70859,9 +70458,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70884,9 +70483,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70896,7 +70495,7 @@ paths: type: array items: *5 examples: - default: &528 + default: &524 value: - id: 1 slug: octoapp @@ -70953,9 +70552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70989,7 +70588,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71010,9 +70609,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71046,7 +70645,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71067,9 +70666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71103,7 +70702,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71125,9 +70724,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -71157,9 +70756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -71218,9 +70817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -71279,9 +70878,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -71340,9 +70939,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -71376,9 +70975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71436,9 +71035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71496,9 +71095,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71558,9 +71157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71582,7 +71181,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *525 examples: default: value: @@ -71696,8 +71295,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -71733,8 +71332,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71807,8 +71406,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -71848,8 +71447,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71919,8 +71518,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71991,8 +71590,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_response_id in: path required: true @@ -72025,8 +71624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -72305,7 +71904,7 @@ paths: description: Response content: application/json: - schema: &530 + schema: &526 title: CheckRun description: A check performed on the code of a given code change type: object @@ -72705,9 +72304,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *466 - - *467 - - &531 + - *462 + - *463 + - &527 name: check_run_id description: The unique identifier of the check run. in: path @@ -72719,9 +72318,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *526 examples: - default: &532 + default: &528 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -72821,9 +72420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 requestBody: required: true content: @@ -73063,9 +72662,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *526 examples: - default: *532 + default: *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73085,9 +72684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 - *17 - *19 responses: @@ -73182,9 +72781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 responses: '201': description: Response @@ -73228,8 +72827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -73251,7 +72850,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &535 + schema: &531 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73341,8 +72940,8 @@ paths: title: Simple Commit description: A commit. type: object - properties: *533 - required: *534 + properties: *529 + required: *530 latest_check_runs_count: type: integer check_runs_url: @@ -73370,7 +72969,7 @@ paths: - check_runs_url - pull_requests examples: - default: &536 + default: &532 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -73661,9 +73260,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *535 + schema: *531 examples: - default: *536 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73682,8 +73281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -73992,9 +73591,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *466 - - *467 - - &537 + - *462 + - *463 + - &533 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74006,9 +73605,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *531 examples: - default: *536 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74031,17 +73630,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: - - *466 - - *467 - - *537 - - &587 + - *462 + - *463 + - *533 + - &585 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &588 + - &586 name: status description: Returns check runs with the specified `status`. in: query @@ -74080,9 +73679,9 @@ paths: type: integer check_runs: type: array - items: *530 + items: *526 examples: - default: &589 + default: &587 value: total_count: 1 check_runs: @@ -74184,9 +73783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *466 - - *467 - - *537 + - *462 + - *463 + - *533 responses: '201': description: Response @@ -74219,21 +73818,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: - - *466 - - *467 + - *462 + - *463 - *316 - *317 - *19 - *17 - - &553 + - &549 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *538 - - &554 + schema: *534 + - &550 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74264,7 +73863,7 @@ paths: be returned. in: query required: false - schema: *539 + schema: *535 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -74288,7 +73887,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *540 + instances_url: *536 state: *113 fixed_at: *137 dismissed_by: @@ -74299,11 +73898,11 @@ paths: required: *21 nullable: true dismissed_at: *136 - dismissed_reason: *541 - dismissed_comment: *542 - rule: *543 - tool: *544 - most_recent_instance: *545 + dismissed_reason: *537 + dismissed_comment: *538 + rule: *539 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -74429,7 +74028,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &546 + '403': &542 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -74456,9 +74055,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: - - *466 - - *467 - - &547 + - *462 + - *463 + - &543 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -74472,7 +74071,7 @@ paths: description: Response content: application/json: - schema: &548 + schema: &544 type: object properties: number: *127 @@ -74480,7 +74079,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *540 + instances_url: *536 state: *113 fixed_at: *137 dismissed_by: @@ -74491,8 +74090,8 @@ paths: required: *21 nullable: true dismissed_at: *136 - dismissed_reason: *541 - dismissed_comment: *542 + dismissed_reason: *537 + dismissed_comment: *538 rule: type: object properties: @@ -74546,8 +74145,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *544 - most_recent_instance: *545 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -74646,7 +74245,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -74666,9 +74265,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: true content: @@ -74683,8 +74282,8 @@ paths: enum: - open - dismissed - dismissed_reason: *541 - dismissed_comment: *542 + dismissed_reason: *537 + dismissed_comment: *538 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -74712,7 +74311,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *544 examples: default: value: @@ -74788,7 +74387,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &552 + '403': &548 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -74815,15 +74414,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 responses: '200': description: Response content: application/json: - schema: &549 + schema: &545 type: object properties: status: @@ -74849,13 +74448,13 @@ paths: - description - started_at examples: - default: &550 + default: &546 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &551 + '400': &547 description: Bad Request content: application/json: @@ -74866,7 +74465,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': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -74891,29 +74490,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 responses: '200': description: OK content: application/json: - schema: *549 + schema: *545 examples: - default: *550 + default: *546 '202': description: Accepted content: application/json: - schema: *549 + schema: *545 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *551 + '400': *547 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -74945,9 +74544,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: false content: @@ -74992,8 +74591,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *551 - '403': *552 + '400': *547 + '403': *548 '404': *6 '422': description: Unprocessable Entity @@ -75017,13 +74616,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *19 - *17 - - *553 - - *554 + - *549 + - *550 responses: '200': description: Response @@ -75034,10 +74633,10 @@ paths: items: type: object properties: - ref: *538 - analysis_key: *555 - environment: *556 - category: *557 + ref: *534 + analysis_key: *551 + environment: *552 + category: *553 state: type: string description: State of a code scanning alert instance. @@ -75052,7 +74651,7 @@ paths: properties: text: type: string - location: *558 + location: *554 html_url: type: string classifications: @@ -75060,7 +74659,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: *559 + items: *555 examples: default: value: @@ -75099,7 +74698,7 @@ paths: end_column: 50 classifications: - source - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75133,25 +74732,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: - - *466 - - *467 + - *462 + - *463 - *316 - *317 - *19 - *17 - - *554 + - *550 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *538 + schema: *534 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &560 + schema: &556 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -75172,23 +74771,23 @@ paths: application/json: schema: type: array - items: &561 + items: &557 type: object properties: - ref: *538 - commit_sha: &569 + ref: *534 + commit_sha: &565 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: *555 + analysis_key: *551 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *557 + category: *553 error: type: string example: error reading field xyz @@ -75212,8 +74811,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *560 - tool: *544 + sarif_id: *556 + tool: *540 deletable: type: boolean warning: @@ -75274,7 +74873,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75310,8 +74909,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: - - *466 - - *467 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75324,7 +74923,7 @@ paths: description: Response content: application/json: - schema: *561 + schema: *557 examples: response: summary: application/json response @@ -75378,7 +74977,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *546 + '403': *542 '404': *6 '422': description: Response if analysis could not be processed @@ -75465,8 +75064,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: - - *466 - - *467 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75519,7 +75118,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': *552 + '403': *548 '404': *6 '503': *195 x-github: @@ -75541,8 +75140,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -75550,7 +75149,7 @@ paths: application/json: schema: type: array - items: &562 + items: &558 title: CodeQL Database description: A CodeQL database. type: object @@ -75661,7 +75260,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': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75690,8 +75289,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: - - *466 - - *467 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -75703,7 +75302,7 @@ paths: description: Response content: application/json: - schema: *562 + schema: *558 examples: default: value: @@ -75735,9 +75334,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': &596 + '302': &594 description: Found - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75759,8 +75358,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *466 - - *467 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -75770,7 +75369,7 @@ paths: responses: '204': description: Response - '403': *552 + '403': *548 '404': *6 '503': *195 x-github: @@ -75798,8 +75397,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -75808,7 +75407,7 @@ paths: type: object additionalProperties: false properties: - language: &563 + language: &559 type: string description: The language targeted by the CodeQL query enum: @@ -75888,7 +75487,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &567 + schema: &563 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -75898,7 +75497,7 @@ paths: description: The ID of the variant analysis. controller_repo: *119 actor: *4 - query_language: *563 + query_language: *559 query_pack_url: type: string description: The download url for the query pack. @@ -75945,7 +75544,7 @@ paths: items: type: object properties: - repository: &564 + repository: &560 title: Repository Identifier description: Repository Identifier type: object @@ -75981,7 +75580,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &568 + analysis_status: &564 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76013,7 +75612,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &565 + access_mismatch_repos: &561 type: object properties: repository_count: @@ -76027,7 +75626,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: *564 + items: *560 required: - repository_count - repositories @@ -76049,8 +75648,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *565 - over_limit_repos: *565 + no_codeql_db_repos: *561 + over_limit_repos: *561 required: - access_mismatch_repos - not_found_repos @@ -76066,7 +75665,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &566 + value: &562 summary: Default response value: id: 1 @@ -76212,10 +75811,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *566 + value: *562 repository_lists: summary: Response for a successful variant analysis submission - value: *566 + value: *562 '404': *6 '422': description: Unable to process variant analysis submission @@ -76243,8 +75842,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: - - *466 - - *467 + - *462 + - *463 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76256,9 +75855,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *563 examples: - default: *566 + default: *562 '404': *6 '503': *195 x-github: @@ -76281,7 +75880,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: - - *466 + - *462 - name: repo in: path description: The name of the controller repository. @@ -76316,7 +75915,7 @@ paths: type: object properties: repository: *119 - analysis_status: *568 + analysis_status: *564 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -76441,8 +76040,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -76527,7 +76126,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -76548,8 +76147,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -76641,7 +76240,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *552 + '403': *548 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -76712,8 +76311,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -76721,7 +76320,7 @@ paths: schema: type: object properties: - commit_sha: *569 + commit_sha: *565 ref: type: string description: |- @@ -76779,7 +76378,7 @@ paths: schema: type: object properties: - id: *560 + id: *556 url: type: string description: The REST API URL for checking the status of the upload. @@ -76793,7 +76392,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': *552 + '403': *548 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -76816,8 +76415,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: - - *466 - - *467 + - *462 + - *463 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -76863,7 +76462,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': *546 + '403': *542 '404': description: Not Found if the sarif id does not match any upload '503': *195 @@ -76888,8 +76487,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -76970,8 +76569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *466 - - *467 + - *462 + - *463 - 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 @@ -77091,8 +76690,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -77406,8 +77005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -77472,7 +77071,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -77480,7 +77079,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '400': *14 '401': *25 '403': *29 @@ -77509,8 +77108,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -77574,8 +77173,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: - - *466 - - *467 + - *462 + - *463 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -77614,8 +77213,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *571 - required: *572 + properties: *567 + required: *568 examples: default: &815 value: @@ -77657,8 +77256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *466 - - *467 + - *462 + - *463 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -77742,8 +77341,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: - - *466 - - *467 + - *462 + - *463 - 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 @@ -77809,8 +77408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -77828,7 +77427,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &572 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -77848,7 +77447,7 @@ paths: - created_at - updated_at examples: - default: *573 + default: *569 headers: Link: *47 x-github: @@ -77871,16 +77470,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *574 + schema: *570 examples: - default: *575 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -77900,17 +77499,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *576 + schema: *572 examples: - default: *577 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77930,8 +77529,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: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -77984,8 +77583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -78014,8 +77613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *466 - - *467 + - *462 + - *463 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78057,7 +77656,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &578 + properties: &574 login: type: string example: octocat @@ -78150,7 +77749,7 @@ paths: user_view_type: type: string example: public - required: &579 + required: &575 - avatar_url - events_url - followers_url @@ -78224,8 +77823,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: - - *466 - - *467 + - *462 + - *463 - *142 responses: '204': @@ -78272,8 +77871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *466 - - *467 + - *462 + - *463 - *142 requestBody: required: false @@ -78300,7 +77899,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &656 + schema: &654 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -78529,8 +78128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *466 - - *467 + - *462 + - *463 - *142 responses: '204': @@ -78562,8 +78161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *466 - - *467 + - *462 + - *463 - *142 responses: '200': @@ -78584,8 +78183,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *578 - required: *579 + properties: *574 + required: *575 nullable: true required: - permission @@ -78640,8 +78239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -78651,7 +78250,7 @@ paths: application/json: schema: type: array - items: &580 + items: &576 title: Commit Comment description: Commit Comment type: object @@ -78709,7 +78308,7 @@ paths: - created_at - updated_at examples: - default: &583 + default: &581 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78768,17 +78367,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': description: Response content: application/json: - schema: *580 + schema: *576 examples: - default: &584 + default: &582 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78835,8 +78434,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -78859,7 +78458,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *576 examples: default: value: @@ -78910,8 +78509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -78933,8 +78532,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -78961,9 +78560,74 @@ paths: application/json: schema: type: array - items: *457 + items: &577 + title: Reaction + description: Reactions to conversations provide a way to help people + express their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *459 + default: &658 + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' headers: Link: *47 '404': *6 @@ -78984,8 +78648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -79018,16 +78682,40 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: &578 + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -79049,10 +78737,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - &659 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -79101,8 +78795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *466 - - *467 + - *462 + - *463 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79158,7 +78852,7 @@ paths: application/json: schema: type: array - items: *581 + items: *579 examples: default: &708 value: @@ -79254,9 +78948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *466 - - *467 - - &582 + - *462 + - *463 + - &580 name: commit_sha description: The SHA of the commit. in: path @@ -79328,9 +79022,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79340,9 +79034,9 @@ paths: application/json: schema: type: array - items: *580 + items: *576 examples: - default: *583 + default: *581 headers: Link: *47 x-github: @@ -79370,9 +79064,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 requestBody: required: true content: @@ -79407,9 +79101,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *576 examples: - default: *584 + default: *582 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79437,9 +79131,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: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79449,7 +79143,7 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: default: &700 value: @@ -79988,11 +79682,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 - - &586 + - &584 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)" @@ -80007,7 +79701,7 @@ paths: description: Response content: application/json: - schema: *581 + schema: *579 examples: default: &685 value: @@ -80122,11 +79816,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: - - *466 - - *467 + - *462 + - *463 + - *584 + - *585 - *586 - - *587 - - *588 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80160,9 +79854,9 @@ paths: type: integer check_runs: type: array - items: *530 + items: *526 examples: - default: *589 + default: *587 headers: Link: *47 x-github: @@ -80187,9 +79881,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: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80197,7 +79891,7 @@ paths: schema: type: integer example: 1 - - *587 + - *585 - *17 - *19 responses: @@ -80215,7 +79909,7 @@ paths: type: integer check_suites: type: array - items: *535 + items: *531 examples: default: value: @@ -80415,9 +80109,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: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - *17 - *19 responses: @@ -80615,9 +80309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - *17 - *19 responses: @@ -80708,7 +80402,7 @@ paths: site_admin: false headers: Link: *47 - '301': *472 + '301': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80736,8 +80430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -80766,20 +80460,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *590 - required: *591 + properties: *588 + required: *589 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &592 + properties: &590 url: type: string format: uri html_url: type: string format: uri - required: &593 + required: &591 - url - html_url nullable: true @@ -80793,26 +80487,26 @@ paths: contributing: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true readme: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true issue_template: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true pull_request_template: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true required: - code_of_conduct @@ -80939,8 +80633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 - name: basehead @@ -80983,8 +80677,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *581 - merge_base_commit: *581 + base_commit: *579 + merge_base_commit: *579 status: type: string enum: @@ -81004,10 +80698,10 @@ paths: example: 6 commits: type: array - items: *581 + items: *579 files: type: array - items: *594 + items: *592 required: - url - html_url @@ -81293,8 +80987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -81437,7 +81131,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &595 + response-if-content-is-a-file: &593 summary: Response if content is a file value: type: file @@ -81770,7 +81464,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *595 + response-if-content-is-a-file: *593 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -81839,7 +81533,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *596 + '302': *594 '304': *37 x-github: githubCloudOnly: false @@ -81862,8 +81556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -81956,7 +81650,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &595 title: File Commit description: File Commit type: object @@ -82108,7 +81802,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *595 examples: example-for-creating-a-file: value: @@ -82162,7 +81856,7 @@ paths: schema: oneOf: - *3 - - &638 + - &636 description: Repository rule violation was detected type: object properties: @@ -82215,8 +81909,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -82277,7 +81971,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *595 examples: default: value: @@ -82332,8 +82026,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *466 - - *467 + - *462 + - *463 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -82456,8 +82150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *332 - *333 - *334 @@ -82469,7 +82163,7 @@ paths: schema: type: string - *336 - - *598 + - *596 - *337 - *338 - *110 @@ -82490,7 +82184,7 @@ paths: application/json: schema: type: array - items: &602 + items: &600 type: object description: A Dependabot alert. properties: @@ -82536,7 +82230,7 @@ paths: - unknown - direct - transitive - security_advisory: *599 + security_advisory: *597 security_vulnerability: *131 url: *132 html_url: *133 @@ -82567,8 +82261,8 @@ paths: nullable: true maxLength: 280 fixed_at: *137 - auto_dismissed_at: *600 - dismissal_request: *601 + auto_dismissed_at: *598 + dismissal_request: *599 required: - number - state @@ -82798,9 +82492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *466 - - *467 - - &603 + - *462 + - *463 + - &601 name: alert_number in: path description: |- @@ -82815,7 +82509,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *600 examples: default: value: @@ -82928,9 +82622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *466 - - *467 - - *603 + - *462 + - *463 + - *601 requestBody: required: true content: @@ -82975,7 +82669,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *600 examples: default: value: @@ -83104,8 +82798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -83123,7 +82817,7 @@ paths: type: integer secrets: type: array - items: &606 + items: &604 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83176,16 +82870,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *604 + schema: *602 examples: - default: *605 + default: *603 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83205,15 +82899,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *606 + schema: *604 examples: default: value: @@ -83239,8 +82933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -83293,8 +82987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -83317,8 +83011,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: - - *466 - - *467 + - *462 + - *463 - 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 @@ -83478,8 +83172,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -83718,8 +83412,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -83794,7 +83488,7 @@ paths: - version - url additionalProperties: false - metadata: &607 + metadata: &605 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83827,7 +83521,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *607 + metadata: *605 resolved: type: object description: A collection of resolved package dependencies. @@ -83840,7 +83534,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *607 + metadata: *605 relationship: type: string description: A notation of whether a dependency is requested @@ -83969,8 +83663,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *466 - - *467 + - *462 + - *463 - name: sha description: The SHA recorded at creation time. in: query @@ -84010,9 +83704,9 @@ paths: application/json: schema: type: array - items: *608 + items: *606 examples: - default: *609 + default: *607 headers: Link: *47 x-github: @@ -84078,8 +83772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -84160,7 +83854,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *606 examples: simple-example: summary: Simple example @@ -84233,9 +83927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *466 - - *467 - - &610 + - *462 + - *463 + - &608 name: deployment_id description: deployment_id parameter in: path @@ -84247,7 +83941,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *606 examples: default: value: @@ -84312,9 +84006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 responses: '204': description: Response @@ -84336,9 +84030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 - *17 - *19 responses: @@ -84348,7 +84042,7 @@ paths: application/json: schema: type: array - items: &611 + items: &609 title: Deployment Status description: The status of a deployment. type: object @@ -84509,9 +84203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 requestBody: required: true content: @@ -84586,9 +84280,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *609 examples: - default: &612 + default: &610 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -84644,9 +84338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 - name: status_id in: path required: true @@ -84657,9 +84351,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *609 examples: - default: *612 + default: *610 '404': *6 x-github: githubCloudOnly: false @@ -84686,12 +84380,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 + - *611 + - *612 - *613 - *614 - - *615 - - *616 - *17 - *19 responses: @@ -84701,9 +84395,9 @@ paths: application/json: schema: type: array - items: *617 + items: *615 examples: - default: *618 + default: *616 '404': *6 '403': *29 '500': *40 @@ -84727,8 +84421,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84740,7 +84434,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *617 + schema: *615 examples: default: value: @@ -84796,8 +84490,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84856,12 +84550,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 + - *611 + - *612 - *613 - *614 - - *615 - - *616 - *17 - *19 responses: @@ -84871,9 +84565,9 @@ paths: application/json: schema: type: array - items: *619 + items: *617 examples: - default: *620 + default: *618 '404': *6 '403': *29 '500': *40 @@ -84897,8 +84591,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84910,7 +84604,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *619 + schema: *617 examples: default: value: @@ -84961,8 +84655,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85000,7 +84694,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *619 + schema: *617 examples: default: value: @@ -85051,8 +84745,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85123,8 +84817,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85157,8 +84851,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -85172,9 +84866,9 @@ paths: application/json: schema: type: array - items: *621 + items: *619 examples: - default: *622 + default: *620 '404': *6 '403': *29 '500': *40 @@ -85199,8 +84893,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85212,7 +84906,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *621 + schema: *619 examples: default: value: @@ -85270,8 +84964,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85340,8 +85034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -85398,8 +85092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -85416,7 +85110,7 @@ paths: type: integer environments: type: array - items: &624 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -85468,7 +85162,7 @@ paths: type: type: string example: wait_timer - wait_timer: &626 + wait_timer: &624 type: integer example: 30 description: The amount of time to delay a job after @@ -85505,7 +85199,7 @@ paths: items: type: object properties: - type: *623 + type: *621 reviewer: anyOf: - *4 @@ -85529,7 +85223,7 @@ paths: - id - node_id - type - deployment_branch_policy: &627 + deployment_branch_policy: &625 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -85645,9 +85339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *466 - - *467 - - &625 + - *462 + - *463 + - &623 name: environment_name in: path required: true @@ -85660,9 +85354,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: &628 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -85746,9 +85440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: false content: @@ -85757,7 +85451,7 @@ paths: type: object nullable: true properties: - wait_timer: *626 + wait_timer: *624 prevent_self_review: type: boolean example: false @@ -85774,13 +85468,13 @@ paths: items: type: object properties: - type: *623 + type: *621 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *627 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -85800,9 +85494,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *628 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -85826,9 +85520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 responses: '204': description: Default response @@ -85853,9 +85547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *17 - *19 responses: @@ -85873,7 +85567,7 @@ paths: example: 2 branch_policies: type: array - items: &629 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -85930,9 +85624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: true content: @@ -85978,9 +85672,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - example-wildcard: &630 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86022,10 +85716,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - &631 + - *462 + - *463 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -86037,9 +85731,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86058,10 +85752,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - *631 + - *462 + - *463 + - *623 + - *629 requestBody: required: true content: @@ -86089,9 +85783,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86110,10 +85804,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - *631 + - *462 + - *463 + - *623 + - *629 responses: '204': description: Response @@ -86138,9 +85832,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 responses: '200': description: List of deployment protection rules @@ -86156,7 +85850,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &632 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -86175,7 +85869,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &633 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86274,9 +85968,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 requestBody: content: application/json: @@ -86297,9 +85991,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *632 + schema: *630 examples: - default: &634 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86334,9 +86028,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 - *19 - *17 responses: @@ -86355,7 +86049,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *633 + items: *631 examples: default: value: @@ -86390,10 +86084,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: - - *466 - - *467 - - *625 - - &635 + - *462 + - *463 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86405,9 +86099,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *630 examples: - default: *634 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86428,10 +86122,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: - - *625 - - *467 - - *466 - - *635 + - *623 + - *463 + - *462 + - *633 responses: '204': description: Response @@ -86457,9 +86151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *17 - *19 responses: @@ -86477,9 +86171,9 @@ paths: type: integer secrets: type: array - items: *497 + items: *493 examples: - default: *498 + default: *494 headers: Link: *47 x-github: @@ -86504,17 +86198,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 responses: '200': description: Response content: application/json: - schema: *499 + schema: *495 examples: - default: *500 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86536,18 +86230,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 responses: '200': description: Response content: application/json: - schema: *497 + schema: *493 examples: - default: *636 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86569,9 +86263,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 requestBody: required: true @@ -86629,9 +86323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 responses: '204': @@ -86657,10 +86351,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *466 - - *467 - - *625 - - *484 + - *462 + - *463 + - *623 + - *480 - *19 responses: '200': @@ -86677,9 +86371,9 @@ paths: type: integer variables: type: array - items: *501 + items: *497 examples: - default: *502 + default: *498 headers: Link: *47 x-github: @@ -86702,9 +86396,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: true content: @@ -86756,18 +86450,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *296 responses: '200': description: Response content: application/json: - schema: *501 + schema: *497 examples: - default: *637 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86788,10 +86482,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 - - *625 + - *623 requestBody: required: true content: @@ -86833,10 +86527,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 - - *625 + - *623 responses: '204': description: Response @@ -86858,8 +86552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -86927,8 +86621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *466 - - *467 + - *462 + - *463 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87087,8 +86781,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -87120,9 +86814,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 '400': *14 '422': *15 '403': *29 @@ -87143,8 +86837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87204,7 +86898,7 @@ paths: schema: oneOf: - *258 - - *638 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87229,8 +86923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *466 - - *467 + - *462 + - *463 - name: file_sha in: path required: true @@ -87329,8 +87023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87439,7 +87133,7 @@ paths: description: Response content: application/json: - schema: &639 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -87653,15 +87347,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 responses: '200': description: Response content: application/json: - schema: *639 + schema: *637 examples: default: value: @@ -87717,9 +87411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *466 - - *467 - - &640 + - *462 + - *463 + - &638 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. @@ -87736,7 +87430,7 @@ paths: application/json: schema: type: array - items: &641 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -87811,17 +87505,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 responses: '200': description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: &642 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -87850,8 +87544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87880,9 +87574,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: *642 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -87908,9 +87602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 requestBody: required: true content: @@ -87939,9 +87633,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: *642 + default: *640 '422': *15 '409': *118 x-github: @@ -87959,9 +87653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 responses: '204': description: Response @@ -88016,8 +87710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -88084,7 +87778,7 @@ paths: description: Response content: application/json: - schema: &644 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -88135,7 +87829,7 @@ paths: - sha - type - url - verification: *643 + verification: *641 required: - sha - url @@ -88145,7 +87839,7 @@ paths: - tag - message examples: - default: &645 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88218,8 +87912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *466 - - *467 + - *462 + - *463 - name: tag_sha in: path required: true @@ -88230,9 +87924,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *642 examples: - default: *645 + default: *643 '404': *6 '409': *118 x-github: @@ -88256,8 +87950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -88330,7 +88024,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88426,8 +88120,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *466 - - *467 + - *462 + - *463 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -88450,7 +88144,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *644 examples: default-response: summary: Default response @@ -88509,8 +88203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -88520,7 +88214,7 @@ paths: application/json: schema: type: array - items: &647 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -88648,8 +88342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -88701,9 +88395,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: &648 + default: &646 value: type: Repository id: 12345678 @@ -88751,17 +88445,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '200': description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: *648 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -88781,8 +88475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 requestBody: required: true @@ -88828,9 +88522,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: *648 + default: *646 '422': *15 '404': *6 x-github: @@ -88851,8 +88545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -88877,8 +88571,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: - - *466 - - *467 + - *462 + - *463 - *348 responses: '200': @@ -88906,8 +88600,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: - - *466 - - *467 + - *462 + - *463 - *348 requestBody: required: false @@ -88952,8 +88646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 - *17 - *349 @@ -88985,8 +88679,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: - - *466 - - *467 + - *462 + - *463 - *348 - *16 responses: @@ -89015,8 +88709,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: - - *466 - - *467 + - *462 + - *463 - *348 - *16 responses: @@ -89040,8 +88734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -89067,8 +88761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -89092,8 +88786,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response if immutable releases are enabled @@ -89139,8 +88833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '409': *118 @@ -89160,8 +88854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '409': *118 @@ -89218,14 +88912,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &649 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -89324,7 +89018,7 @@ paths: - html_url - authors_url examples: - default: &652 + default: &650 value: vcs: subversion use_lfs: true @@ -89340,7 +89034,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': &650 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -89369,8 +89063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -89418,7 +89112,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: default: value: @@ -89443,7 +89137,7 @@ paths: type: string '422': *15 '404': *6 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89471,8 +89165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -89521,7 +89215,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: example-1: summary: Example 1 @@ -89569,7 +89263,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': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89592,12 +89286,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89623,8 +89317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *466 - - *467 + - *462 + - *463 - &836 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -89639,7 +89333,7 @@ paths: application/json: schema: type: array - items: &651 + items: &649 title: Porter Author description: Porter Author type: object @@ -89693,7 +89387,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': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89718,8 +89412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *466 - - *467 + - *462 + - *463 - name: author_id in: path required: true @@ -89749,7 +89443,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *649 examples: default: value: @@ -89762,7 +89456,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89786,8 +89480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89828,7 +89522,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89856,8 +89550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -89884,11 +89578,11 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: - default: *652 + default: *650 '422': *15 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89911,8 +89605,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89920,8 +89614,8 @@ paths: application/json: schema: *22 examples: - default: *653 - '301': *472 + default: *651 + '301': *468 '404': *6 x-github: githubCloudOnly: false @@ -89941,8 +89635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89955,7 +89649,7 @@ paths: properties: {} additionalProperties: false examples: - default: &655 + default: &653 value: limit: collaborators_only origin: repository @@ -89980,13 +89674,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *654 + schema: *652 examples: default: summary: Example request body @@ -90000,7 +89694,7 @@ paths: application/json: schema: *366 examples: - default: *655 + default: *653 '409': description: Response x-github: @@ -90022,8 +89716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -90046,8 +89740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -90057,7 +89751,7 @@ paths: application/json: schema: type: array - items: *656 + items: *654 examples: default: &829 value: @@ -90190,8 +89884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *466 - - *467 + - *462 + - *463 - *370 requestBody: required: false @@ -90221,7 +89915,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *654 examples: default: value: @@ -90352,8 +90046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *466 - - *467 + - *462 + - *463 - *370 responses: '204': @@ -90385,8 +90079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *466 - - *467 + - *462 + - *463 - 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 @@ -90607,7 +90301,7 @@ paths: state_reason: completed headers: Link: *47 - '301': *472 + '301': *468 '422': *15 '404': *6 x-github: @@ -90636,8 +90330,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -90877,7 +90571,7 @@ paths: '422': *15 '503': *195 '404': *6 - '410': *657 + '410': *655 x-github: triggersNotification: true githubCloudOnly: false @@ -90905,8 +90599,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *244 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -90927,7 +90621,7 @@ paths: application/json: schema: type: array - items: *658 + items: *656 examples: default: &665 value: @@ -90987,17 +90681,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: &659 + default: &657 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91051,8 +90745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -91075,9 +90769,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: *659 + default: *657 '422': *15 x-github: githubCloudOnly: false @@ -91095,8 +90789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -91117,8 +90811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -91145,9 +90839,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -91168,8 +90862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -91202,16 +90896,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -91233,10 +90927,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - *659 responses: '204': description: Response @@ -91256,8 +90950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -91618,8 +91312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *466 - - *467 + - *462 + - *463 - name: event_id in: path required: true @@ -91822,7 +91516,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *657 + '410': *655 '403': *29 x-github: githubCloudOnly: false @@ -91856,8 +91550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - &664 name: issue_number description: The number that identifies the issue. @@ -91873,9 +91567,9 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '304': *37 x-github: githubCloudOnly: false @@ -91900,8 +91594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -92012,9 +91706,9 @@ paths: '422': *15 '503': *195 '403': *29 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92032,8 +91726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -92078,8 +91772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: content: @@ -92129,8 +91823,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - name: assignee in: path @@ -92171,8 +91865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *227 - *17 @@ -92184,13 +91878,13 @@ paths: application/json: schema: type: array - items: *658 + items: *656 examples: default: *665 headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92219,8 +91913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -92243,16 +91937,16 @@ paths: description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: *659 + default: *657 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -92280,8 +91974,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -92297,9 +91991,9 @@ paths: default: *666 headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92327,8 +92021,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -92359,9 +92053,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *472 + '301': *468 '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -92392,8 +92086,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - name: issue_id in: path @@ -92409,12 +92103,12 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *657 + '410': *655 x-github: triggersNotification: true githubCloudOnly: false @@ -92440,8 +92134,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -92457,9 +92151,9 @@ paths: default: *666 headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92476,8 +92170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93329,7 +93023,7 @@ paths: color: red headers: Link: *47 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93346,8 +93040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93378,9 +93072,9 @@ paths: default: false headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93397,8 +93091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93461,9 +93155,9 @@ paths: items: *219 examples: default: *667 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '422': *15 x-github: githubCloudOnly: false @@ -93480,8 +93174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93545,9 +93239,9 @@ paths: items: *219 examples: default: *667 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '422': *15 x-github: githubCloudOnly: false @@ -93564,15 +93258,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '204': description: Response - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93591,8 +93285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - name: name in: path @@ -93617,9 +93311,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93639,8 +93333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93669,7 +93363,7 @@ paths: '204': description: Response '403': *29 - '410': *657 + '410': *655 '404': *6 '422': *15 x-github: @@ -93687,8 +93381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '204': @@ -93719,8 +93413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '200': @@ -93730,9 +93424,9 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93749,8 +93443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -93777,13 +93471,13 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93801,8 +93495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -93835,16 +93529,16 @@ paths: description: Response content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Response content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -93866,10 +93560,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *664 - - *460 + - *659 responses: '204': description: Response @@ -93898,8 +93592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -93957,8 +93651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93975,7 +93669,7 @@ paths: headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94003,8 +93697,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -94041,7 +93735,7 @@ paths: schema: type: string '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -94061,8 +93755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -94118,8 +93812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -94665,7 +94359,7 @@ paths: type: string comments: type: array - items: *580 + items: *576 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -94954,7 +94648,7 @@ paths: headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94971,8 +94665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -95048,8 +94742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95121,8 +94815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 - &683 name: key_id description: The unique identifier of the key. @@ -95155,8 +94849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 - *683 responses: '204': @@ -95177,8 +94871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -95211,8 +94905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95282,8 +94976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95313,8 +95007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95379,8 +95073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95406,8 +95100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -95443,8 +95137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '202': *39 '403': @@ -95472,8 +95166,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -95499,9 +95193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *466 - - *467 - - *553 + - *462 + - *463 + - *549 responses: '200': description: Response @@ -95646,8 +95340,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95712,8 +95406,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95747,7 +95441,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *581 + schema: *579 examples: default: *685 '204': @@ -95774,8 +95468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *466 - - *467 + - *462 + - *463 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -95877,8 +95571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95979,8 +95673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - &688 name: milestone_number description: The number that identifies the milestone. @@ -96012,8 +95706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 requestBody: required: false @@ -96070,8 +95764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 responses: '204': @@ -96093,8 +95787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 - *17 - *19 @@ -96126,8 +95820,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *466 - - *467 + - *462 + - *463 - *689 - *690 - *227 @@ -96167,8 +95861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -96226,8 +95920,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -96399,8 +96093,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96479,8 +96173,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96587,8 +96281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -96614,8 +96308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -96719,8 +96413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -96765,8 +96459,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -96822,8 +96516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *466 - - *467 + - *462 + - *463 - name: build_id in: path required: true @@ -96856,8 +96550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96962,8 +96656,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - &697 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -97022,8 +96716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *466 - - *467 + - *462 + - *463 - *697 responses: '204': *154 @@ -97051,8 +96745,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -97310,8 +97004,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Private vulnerability reporting status @@ -97348,8 +97042,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: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '422': *14 @@ -97370,8 +97064,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: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '422': *14 @@ -97393,8 +97087,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -97426,8 +97120,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -97481,8 +97175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -97542,7 +97236,7 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: default: *700 headers: @@ -97576,8 +97270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -98475,8 +98169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - name: sort in: query required: false @@ -98584,8 +98278,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': @@ -98669,8 +98363,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: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -98711,8 +98405,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: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -98734,8 +98428,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: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -98762,9 +98456,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -98785,8 +98479,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: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -98819,16 +98513,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -98850,10 +98544,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - *659 responses: '204': description: Response @@ -98896,8 +98590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - &706 name: pull_number description: The number that identifies the pull request. @@ -98948,8 +98642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99016,8 +98710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -99080,7 +98774,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -99088,7 +98782,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -99118,8 +98812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *244 - name: direction @@ -99176,8 +98870,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -99371,8 +99065,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *236 requestBody: @@ -99482,8 +99176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -99494,7 +99188,7 @@ paths: application/json: schema: type: array - items: *581 + items: *579 examples: default: *708 headers: @@ -99526,8 +99220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -99538,7 +99232,7 @@ paths: application/json: schema: type: array - items: *594 + items: *592 examples: default: value: @@ -99576,8 +99270,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 responses: '204': @@ -99601,8 +99295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99714,8 +99408,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 responses: '200': @@ -99791,8 +99485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99830,7 +99524,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -100366,8 +100060,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -100402,7 +100096,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -100907,8 +100601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -101070,8 +100764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -101223,8 +100917,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - &710 name: review_id @@ -101299,8 +100993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101387,8 +101081,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 - *710 responses: @@ -101425,8 +101119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 - *17 @@ -101663,8 +101357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101757,8 +101451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101819,8 +101513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -101884,8 +101578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *466 - - *467 + - *462 + - *463 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -101942,8 +101636,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: - - *466 - - *467 + - *462 + - *463 - name: dir description: The alternate path to look for a README file in: path @@ -101987,8 +101681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -102092,8 +101786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -102276,8 +101970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - &717 name: asset_id description: The unique identifier of the asset. @@ -102327,7 +102021,7 @@ paths: type: User site_admin: false '404': *6 - '302': *596 + '302': *594 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102343,8 +102037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - *717 requestBody: required: false @@ -102391,8 +102085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - *717 responses: '204': @@ -102417,8 +102111,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -102503,8 +102197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -102529,8 +102223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *466 - - *467 + - *462 + - *463 - name: tag description: tag parameter in: path @@ -102567,8 +102261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *466 - - *467 + - *462 + - *463 - &720 name: release_id description: The unique identifier of the release. @@ -102603,8 +102297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 requestBody: required: false @@ -102692,8 +102386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 responses: '204': @@ -102714,8 +102408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *466 - - *467 + - *462 + - *463 - *720 - *17 - *19 @@ -102808,8 +102502,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *720 - name: name in: query @@ -102891,8 +102585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -102917,9 +102611,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -102940,8 +102634,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 requestBody: required: true @@ -102972,16 +102666,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -103003,10 +102697,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *720 - - *460 + - *659 responses: '204': description: Response @@ -103030,9 +102724,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 - *17 - *19 responses: @@ -103169,8 +102863,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - name: includes_parents @@ -103236,8 +102930,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 requestBody: description: Request body required: true @@ -103346,8 +103040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *466 - - *467 + - *462 + - *463 - *725 - *105 - *726 @@ -103382,8 +103076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *466 - - *467 + - *462 + - *463 - *730 responses: '200': @@ -103420,8 +103114,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103461,8 +103155,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103544,8 +103238,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103568,8 +103262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - name: ruleset_id @@ -103606,8 +103300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103680,8 +103374,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: - - *466 - - *467 + - *462 + - *463 - *427 - *428 - *429 @@ -103968,9 +103662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *435 responses: '200': @@ -104031,9 +103725,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: true content: @@ -104171,9 +103865,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *19 - *17 responses: @@ -104308,8 +104002,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -104387,8 +104081,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: - - *466 - - *467 + - *462 + - *463 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -104507,8 +104201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *466 - - *467 + - *462 + - *463 - *110 - name: sort description: The property to sort the results by. @@ -104577,8 +104271,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -104973,8 +104667,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -105225,8 +104919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *466 - - *467 + - *462 + - *463 - *758 responses: '200': @@ -105259,8 +104953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *466 - - *467 + - *462 + - *463 - *758 requestBody: required: true @@ -105461,8 +105155,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *758 responses: '202': *39 @@ -105490,17 +105184,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: - - *466 - - *467 + - *462 + - *463 - *758 responses: '202': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 '400': *14 '422': *15 '403': *29 @@ -105526,8 +105220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -105626,8 +105320,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -105669,8 +105363,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -105746,8 +105440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -105843,8 +105537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -105998,8 +105692,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106042,8 +105736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *466 - - *467 + - *462 + - *463 - name: sha in: path required: true @@ -106151,8 +105845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106184,8 +105878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: if you subscribe to the repository @@ -106259,8 +105953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -106313,8 +106007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -106334,8 +106028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106414,8 +106108,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -106475,8 +106169,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -106530,8 +106224,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: - - *466 - - *467 + - *462 + - *463 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -106568,8 +106262,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *466 - - *467 + - *462 + - *463 - name: ref in: path required: true @@ -106605,8 +106299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106638,8 +106332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 responses: @@ -106682,8 +106376,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -106737,8 +106431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *466 - - *467 + - *462 + - *463 - &766 name: per description: The time frame to display results for. @@ -106856,8 +106550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -106948,8 +106642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -107010,8 +106704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *466 - - *467 + - *462 + - *463 - *766 responses: '200': @@ -107109,8 +106803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -107384,8 +107078,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -107408,8 +107102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -107431,8 +107125,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -107458,8 +107152,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *466 - - *467 + - *462 + - *463 - name: ref in: path required: true @@ -107551,9 +107245,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -110025,7 +109719,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true comment_count: type: integer @@ -110045,7 +109739,7 @@ paths: url: type: string format: uri - verification: *643 + verification: *641 required: - author - committer @@ -110064,7 +109758,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true parents: type: array @@ -112266,246 +111960,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - *799 - - *453 - - *456 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - *799 - - *453 - - *456 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - *799 - - *453 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - *799 - - *453 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -112731,7 +112185,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-user-is-a-team-maintainer: *804 '404': *6 @@ -112792,7 +112246,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-users-membership-with-team-is-now-pending: *805 '403': @@ -112899,8 +112353,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Alternative response with extra repository information @@ -113058,8 +112512,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -113110,8 +112564,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -113146,9 +112600,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 '403': *29 '404': *6 x-github: @@ -113232,7 +112686,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: default: value: @@ -114010,7 +113464,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -114018,7 +113472,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -114102,7 +113556,7 @@ paths: - visibility - selected_repositories_url examples: - default: *573 + default: *569 headers: Link: *47 x-github: @@ -114476,7 +113930,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '304': *37 '500': *40 '401': *25 @@ -114534,7 +113988,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -114797,13 +114251,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *471 + repository: *467 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *571 - required: *572 + properties: *567 + required: *568 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -115585,7 +115039,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '304': *37 '500': *40 '400': *14 @@ -115625,7 +115079,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '500': *40 '401': *25 '403': *29 @@ -116773,7 +116227,7 @@ paths: required: true content: application/json: - schema: *654 + schema: *652 examples: default: value: @@ -119202,9 +118656,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -119242,7 +118696,7 @@ paths: application/json: schema: type: array - items: *656 + items: *654 examples: default: *829 headers: @@ -119856,8 +119310,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response if this repository is starred by you @@ -119885,8 +119339,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -119910,8 +119364,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -120591,7 +120045,7 @@ paths: initiator: type: string examples: - default: *513 + default: *509 '201': description: Response content: @@ -121122,7 +120576,7 @@ paths: application/json: schema: *22 examples: - default: *653 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -128802,7 +128256,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129125,7 +128579,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129455,7 +128909,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129797,7 +129251,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -130067,7 +129521,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130348,7 +129802,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130659,7 +130113,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -131758,7 +131212,7 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -131846,7 +131300,7 @@ x-webhooks: type: string enum: - auto_reopened - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -131934,7 +131388,7 @@ x-webhooks: type: string enum: - created - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132020,7 +131474,7 @@ x-webhooks: type: string enum: - dismissed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132106,7 +131560,7 @@ x-webhooks: type: string enum: - fixed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132193,7 +131647,7 @@ x-webhooks: type: string enum: - reintroduced - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132279,7 +131733,7 @@ x-webhooks: type: string enum: - reopened - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -133772,7 +133226,7 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *608 + deployment: *606 pull_requests: type: array items: *704 @@ -237205,7 +236659,7 @@ x-webhooks: enterprise: *859 installation: *860 organization: *861 - repository: *471 + repository: *467 sender: *4 required: - changes @@ -242428,7 +241882,7 @@ x-webhooks: type: string required: - conclusion - deployment: *608 + deployment: *606 required: - action - repository @@ -242770,7 +242224,7 @@ x-webhooks: required: - status - steps - deployment: *608 + deployment: *606 required: - action - repository @@ -242987,7 +242441,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *608 + deployment: *606 required: - action - repository @@ -243205,7 +242659,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *608 + deployment: *606 required: - action - repository diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index f98a62623..3cfc84009 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -252815,17 +252815,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-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/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -252845,61 +252845,6 @@ "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" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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": { @@ -252908,236 +252853,92 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "example": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ], + "type": "array", + "items": { "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], "properties": { - "name": { - "nullable": true, - "type": "string" + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "email": { - "nullable": true, + "group_name": { + "description": "The display name of the group", + "example": "group-azuread-test", "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "updated_at": { + "description": "The time of the last update for this group", + "example": "2019-06-03 22:27:15:000 -700", + "type": "string" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "external-groups" } }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -253157,24 +252958,6 @@ "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": { @@ -253184,29 +252967,20 @@ "schema": { "type": "object", "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "group_id": { + "type": "integer", + "description": "External Group Id", + "example": 1 } }, "required": [ - "content" + "group_id" ] }, "examples": { "default": { "value": { - "content": "heart" + "group_id": 123 } } } @@ -253215,407 +252989,149 @@ }, "responses": { "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], "properties": { - "id": { - "type": "integer", - "example": 1 + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "group_name": { + "description": "The display name for the group", + "example": "group-azuread-test", + "type": "string" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "updated_at": { + "description": "The date when the group was last updated_at", + "example": "2021-01-03 22:27:15:000 -700", + "type": "string" + }, + "teams": { + "description": "An array of teams linked to this group", + "example": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "example": 1, + "type": "integer" + }, + "team_name": { + "description": "The name of the team", + "example": "team-test", + "type": "string" + } + } + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "members": { + "description": "An array of external members linked to this group", + "example": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "example": 1, + "type": "integer" + }, + "member_login": { + "description": "The handle/login for the user", + "example": "mona-lisa_eocsaxrs", + "type": "string" + }, + "member_name": { + "description": "The user display name/profile name", + "example": "Mona Lisa", + "type": "string" + }, + "member_email": { + "description": "An email attached to a user", + "example": "mona_lisa@github.com", + "type": "string" + } + } + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "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" + } ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" } } } @@ -253624,24 +253140,22 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + }, "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -253661,33 +253175,6 @@ "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" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -253696,24 +253183,24 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/invitations": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`.\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 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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -253734,34 +253221,6 @@ "type": "string" } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, { "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).\"", @@ -253789,19 +253248,37 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Organization Invitation", + "description": "Organization Invitation", "type": "object", "properties": { "id": { "type": "integer", - "example": 1 + "format": "int64" }, - "node_id": { + "login": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "nullable": true }, - "user": { + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -253923,36 +253400,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -253961,29 +253436,36 @@ "value": [ { "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "login": "octocat", - "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -254003,20 +253485,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "members" } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" }, "parameters": [ { @@ -254038,229 +253522,175 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } + }, + { + "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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "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": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -254279,215 +253709,17 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } + } + ] } } } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } + "type": "string" } } } @@ -254495,23 +253727,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -254533,62 +253765,8 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/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.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -254602,92 +253780,73 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", + "title": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "example": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name of the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The time of the last update for this group", - "example": "2019-06-03 22:27:15:000 -700", - "type": "string" - } - } - } + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } - } + }, + "required": [ + "role", + "state", + "url" + ] }, "examples": { - "default": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", "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" - } - ] + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" } } } } } + }, + "404": { + "description": "if user has no team membership" } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "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/link-external-idp-group-to-team-for-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/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -254707,29 +253866,40 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "example": 1 + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" } - }, - "required": [ - "group_id" - ] + } }, "examples": { "default": { + "summary": "Add or update team membership for an organization member", "value": { - "group_id": 123 + "role": "maintainer" } } } @@ -254742,995 +253912,76 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", + "title": "Team Membership", + "description": "Team Membership", "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name for the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "example": "2021-01-03 22:27:15:000 -700", - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "teams": { - "description": "An array of teams linked to this group", - "example": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "example": 1, - "type": "integer" - }, - "team_name": { - "description": "The name of the team", - "example": "team-test", - "type": "string" - } - } - } + "default": "member", + "example": "member", + "type": "string" }, - "members": { - "description": "An array of external members linked to this group", - "example": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ], - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "example": 1, - "type": "integer" - }, - "member_login": { - "description": "The handle/login for the user", - "example": "mona-lisa_eocsaxrs", - "type": "string" - }, - "member_name": { - "description": "The user display name/profile name", - "example": "Mona Lisa", - "type": "string" - }, - "member_email": { - "description": "An email attached to a user", - "example": "mona_lisa@github.com", - "type": "string" - } - } - } + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] } - } + }, + "required": [ + "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": { - "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" - } - ] + "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": true, - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, "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.", + "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/unlink-external-idp-group-from-team-for-org", + "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#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", - "nullable": true - }, - "email": { - "type": "string", - "nullable": true - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": "string", - "nullable": true - }, - "failed_reason": { - "type": "string", - "nullable": true - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - }, - "invitation_teams_url": { - "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" - }, - "invitation_source": { - "type": "string", - "example": "\"member\"" - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/members": { - "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "tags": [ - "teams" - ], - "operationId": "teams/list-members-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - } - } - } - } - }, - "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role that this user should have in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -597794,2422 +596045,670 @@ "type": "string", "example": "MDQ6VGVhbTE=" }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/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", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions": { - "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/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-discussions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "post": { - "summary": "Create a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - }, - "private": { - "type": "boolean", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "default": false - } - }, - "required": [ - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -600218,20 +596717,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": [ { @@ -600242,20 +596741,106 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -600264,22 +596849,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": [ { @@ -600291,15 +596876,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.", @@ -600341,8 +596917,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": { @@ -600471,57 +597047,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -600578,12 +597178,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -600613,19 +597218,24 @@ "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", + "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, - "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, @@ -600658,20 +597268,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": [ { @@ -600682,15 +597292,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -600700,19 +597301,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." } } } @@ -600725,8 +597337,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": { @@ -600855,57 +597467,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -600962,12 +597598,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -600995,19 +597636,24 @@ "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", + "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, - "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, @@ -601032,22 +597678,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": [ { @@ -601067,15 +597713,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -601084,8 +597721,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": { @@ -601214,57 +597851,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -601321,12 +597982,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -601354,19 +598020,24 @@ "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", + "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, - "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, @@ -601390,20 +598061,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": [ { @@ -601423,37 +598094,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" } } } @@ -601466,8 +598129,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": { @@ -601596,57 +598259,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -601703,12 +598390,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -601736,19 +598428,24 @@ "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", + "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", - "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, @@ -601772,20 +598469,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": [ { @@ -601805,15 +598502,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -601827,22 +598515,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}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", + "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -601864,31 +598552,17 @@ } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -601918,19 +598592,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602055,33 +598721,122 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] } }, @@ -602089,9 +598844,7 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602111,8 +598864,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -602132,23 +598906,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -602168,15 +598942,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -602186,29 +598951,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like apples?" } } } @@ -602221,19 +598976,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602358,41 +599105,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602412,8 +599246,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -602422,27 +599277,28 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-legacy", + "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -602464,40 +599320,12 @@ } }, { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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", + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -602507,239 +599335,326 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "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": [ - { + "value": { + "author": { + "login": "octocat", "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-legacy", + "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -602759,6 +599674,15 @@ "schema": { "type": "integer" } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -602768,29 +599692,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like pineapples?" } } } @@ -602798,24 +599712,16 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -602940,41 +599846,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -602994,8 +599987,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -603005,11 +600019,66 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "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": [ + { + "name": "team_id", + "description": "The unique identifier of the team.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "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, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 8083f5d1e..0d22fd19a 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -13108,7 +13108,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &540 + instances_url: &536 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13143,7 +13143,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &541 + dismissed_reason: &537 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -13152,13 +13152,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &542 + dismissed_comment: &538 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &543 + rule: &539 type: object properties: id: @@ -13211,7 +13211,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &544 + tool: &540 type: object properties: name: *111 @@ -13221,26 +13221,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &545 + most_recent_instance: &541 type: object properties: - ref: &538 + ref: &534 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &555 + analysis_key: &551 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: &556 + environment: &552 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: &557 + category: &553 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13254,7 +13254,7 @@ paths: properties: text: type: string - location: &558 + location: &554 type: object description: Describe a region within a file for the alert. properties: @@ -13275,7 +13275,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &559 + items: &555 type: string description: A classification of the file. For example to identify it as generated. @@ -16938,7 +16938,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &598 + - &596 name: has in: query description: |- @@ -17051,7 +17051,7 @@ paths: - unknown - direct - transitive - security_advisory: &599 + security_advisory: &597 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17283,14 +17283,14 @@ paths: nullable: true maxLength: 280 fixed_at: *137 - auto_dismissed_at: &600 + auto_dismissed_at: &598 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &601 + dismissal_request: &599 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -25885,7 +25885,7 @@ paths: action: type: string issue: *220 - comment: &658 + comment: &656 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -30559,14 +30559,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &466 + - &462 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &467 + - &463 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -30628,7 +30628,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &472 + '301': &468 description: Moved permanently content: application/json: @@ -33130,7 +33130,7 @@ paths: type: integer repository_cache_usages: type: array - items: &479 + items: &475 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -36286,7 +36286,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &495 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -36315,7 +36315,7 @@ paths: - key_id - key examples: - default: &500 + default: &496 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -36728,7 +36728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *87 - - &484 + - &480 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)." @@ -38348,7 +38348,7 @@ paths: initiator: type: string examples: - default: &513 + default: &509 value: attestations: - bundle: @@ -39265,7 +39265,7 @@ paths: be returned. in: query required: false - schema: &539 + schema: &535 type: string description: Severity of a code scanning alert. enum: @@ -40319,7 +40319,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &571 + properties: &567 name: type: string description: The name of the machine. @@ -40361,7 +40361,7 @@ paths: - ready - in_progress nullable: true - required: &572 + required: &568 - name - display_name - operating_system @@ -41229,7 +41229,7 @@ paths: - updated_at - visibility examples: - default: &573 + default: &569 value: total_count: 2 secrets: @@ -41267,7 +41267,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &570 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -41296,7 +41296,7 @@ paths: - key_id - key examples: - default: &575 + default: &571 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41328,7 +41328,7 @@ paths: application/json: schema: *327 examples: - default: &577 + default: &573 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -43187,7 +43187,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &602 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -43204,7 +43204,7 @@ paths: - key_id - key examples: - default: &605 + default: &603 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -43534,7 +43534,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &613 + - &611 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -43542,7 +43542,7 @@ paths: required: false schema: type: string - - &614 + - &612 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -43550,7 +43550,7 @@ paths: required: false schema: type: string - - &615 + - &613 name: time_period description: |- The time period to filter by. @@ -43566,7 +43566,7 @@ paths: - week - month default: month - - &616 + - &614 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -43591,7 +43591,7 @@ paths: application/json: schema: type: array - items: &617 + items: &615 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -43747,7 +43747,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &618 + default: &616 value: - id: 21 number: 42 @@ -43865,7 +43865,7 @@ paths: application/json: schema: type: array - items: &619 + items: &617 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -43982,7 +43982,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &620 + default: &618 value: - id: 21 number: 42 @@ -44084,7 +44084,7 @@ paths: application/json: schema: type: array - items: &621 + items: &619 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -44205,7 +44205,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &622 + default: &620 value: - id: 21 number: 42 @@ -44550,7 +44550,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &459 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -44631,7 +44631,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &464 + default: &460 value: group_id: '123' group_name: Octocat admins @@ -44686,7 +44686,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &457 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -44723,7 +44723,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &462 + default: &458 value: groups: - group_id: '123' @@ -46025,7 +46025,7 @@ paths: application/json: schema: *22 examples: - default: &653 + default: &651 value: id: 1 account: @@ -46250,7 +46250,7 @@ paths: required: true content: application/json: - schema: &654 + schema: &652 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -47111,7 +47111,7 @@ paths: application/json: schema: *376 examples: - default: &570 + default: &566 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -51781,7 +51781,7 @@ paths: content: oneOf: - *220 - - &585 + - &583 title: Pull Request Simple description: Pull Request Simple type: object @@ -54650,7 +54650,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &467 title: Full Repository description: Full Repository type: object @@ -55043,7 +55043,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &590 + properties: &588 url: type: string format: uri @@ -55059,7 +55059,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &591 + required: &589 - url - key - name @@ -55148,7 +55148,7 @@ paths: - network_count - subscribers_count examples: - default: &473 + default: &469 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -58024,7 +58024,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &464 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -58070,7 +58070,7 @@ paths: type: string nullable: true examples: - default: &469 + default: &465 value: groups: - group_id: '123' @@ -59679,407 +59679,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - *87 - - *215 - - *453 - - *456 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &457 - title: Reaction - description: Reactions to conversations provide a way to help people - express their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &459 - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - *87 - - *215 - - *453 - - *456 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: *457 - examples: - default: &458 - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - *87 - - *215 - - *453 - - *456 - - &460 - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - *87 - - *215 - - *453 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - *87 - - *215 - - *453 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - *87 - - *215 - - *453 - - *460 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/external-groups": get: summary: List a connection between an external group and a team @@ -60101,9 +59700,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *457 examples: - default: *462 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60146,9 +59745,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *459 examples: - default: *464 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60289,7 +59888,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &461 title: Team Membership description: Team Membership type: object @@ -60379,7 +59978,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-users-membership-with-team-is-now-pending: &805 summary: Response if user's membership with team is now pending @@ -60488,8 +60087,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Alternative response with repository permissions @@ -61066,8 +60665,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -61114,8 +60713,8 @@ paths: parameters: - *87 - *215 - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -61148,9 +60747,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61216,7 +60815,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: default: value: @@ -61415,7 +61014,7 @@ paths: resources: type: object properties: - core: &470 + core: &466 title: Rate Limit type: object properties: @@ -61432,21 +61031,21 @@ paths: - remaining - reset - used - graphql: *470 - search: *470 - code_search: *470 - source_import: *470 - integration_manifest: *470 - code_scanning_upload: *470 - actions_runner_registration: *470 - scim: *470 - dependency_snapshots: *470 - dependency_sbom: *470 - code_scanning_autofix: *470 + graphql: *466 + search: *466 + code_search: *466 + source_import: *466 + integration_manifest: *466 + code_scanning_upload: *466 + actions_runner_registration: *466 + scim: *466 + dependency_snapshots: *466 + dependency_sbom: *466 + code_scanning_autofix: *466 required: - core - search - rate: *470 + rate: *466 required: - rate - resources @@ -61551,14 +61150,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: default-response: summary: Default response @@ -62063,7 +61662,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *472 + '301': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62081,8 +61680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -62339,10 +61938,10 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 - '307': &474 + default: *469 + '307': &470 description: Temporary Redirect content: application/json: @@ -62371,8 +61970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -62394,7 +61993,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': *474 + '307': *470 '404': *6 '409': *118 x-github: @@ -62418,11 +62017,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - - &491 + - &487 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62445,7 +62044,7 @@ paths: type: integer artifacts: type: array - items: &475 + items: &471 title: Artifact description: An artifact type: object @@ -62523,7 +62122,7 @@ paths: - expires_at - updated_at examples: - default: &492 + default: &488 value: total_count: 2 artifacts: @@ -62584,9 +62183,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *466 - - *467 - - &476 + - *462 + - *463 + - &472 name: artifact_id description: The unique identifier of the artifact. in: path @@ -62598,7 +62197,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *471 examples: default: value: @@ -62636,9 +62235,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *466 - - *467 - - *476 + - *462 + - *463 + - *472 responses: '204': description: Response @@ -62662,9 +62261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *466 - - *467 - - *476 + - *462 + - *463 + - *472 - name: archive_format in: path required: true @@ -62678,7 +62277,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': &657 + '410': &655 description: Gone content: application/json: @@ -62703,14 +62302,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &477 + schema: &473 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -62743,13 +62342,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *477 + schema: *473 examples: selected_actions: *44 responses: @@ -62778,14 +62377,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &478 + schema: &474 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -62818,13 +62417,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *478 + schema: *474 examples: selected_actions: *46 responses: @@ -62855,14 +62454,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: default: value: @@ -62888,11 +62487,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: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - - &480 + - &476 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 @@ -62926,7 +62525,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &477 title: Repository actions caches description: Repository actions caches type: object @@ -62968,7 +62567,7 @@ paths: - total_count - actions_caches examples: - default: &482 + default: &478 value: total_count: 1 actions_caches: @@ -63000,23 +62599,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: - - *466 - - *467 + - *462 + - *463 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *480 + - *476 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63036,8 +62635,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: - - *466 - - *467 + - *462 + - *463 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63068,9 +62667,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: - - *466 - - *467 - - &483 + - *462 + - *463 + - &479 name: job_id description: The unique identifier of the job. in: path @@ -63082,7 +62681,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &491 title: Job description: Information of a job execution in a workflow run type: object @@ -63389,9 +62988,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: - - *466 - - *467 - - *483 + - *462 + - *463 + - *479 responses: '302': description: Response @@ -63419,9 +63018,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: - - *466 - - *467 - - *483 + - *462 + - *463 + - *479 requestBody: required: false content: @@ -63466,8 +63065,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Status response @@ -63517,8 +63116,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -63581,8 +63180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -63600,7 +63199,7 @@ paths: type: integer secrets: type: array - items: &497 + items: &493 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63620,7 +63219,7 @@ paths: - created_at - updated_at examples: - default: &498 + default: &494 value: total_count: 2 secrets: @@ -63653,9 +63252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *466 - - *467 - - *484 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -63672,7 +63271,7 @@ paths: type: integer variables: type: array - items: &501 + items: &497 title: Actions Variable type: object properties: @@ -63702,7 +63301,7 @@ paths: - created_at - updated_at examples: - default: &502 + default: &498 value: total_count: 2 variables: @@ -63735,8 +63334,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -63745,7 +63344,7 @@ paths: schema: type: object properties: - enabled: &485 + enabled: &481 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -63780,8 +63379,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -63792,7 +63391,7 @@ paths: schema: type: object properties: - enabled: *485 + enabled: *481 allowed_actions: *60 sha_pinning_required: *61 required: @@ -63825,14 +63424,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &486 + schema: &482 type: object properties: access_level: @@ -63850,7 +63449,7 @@ paths: required: - access_level examples: - default: &487 + default: &483 value: access_level: organization x-github: @@ -63875,15 +63474,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *486 + schema: *482 examples: - default: *487 + default: *483 responses: '204': description: Response @@ -63907,8 +63506,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -63938,8 +63537,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Empty response for successful settings update @@ -63973,8 +63572,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64001,8 +63600,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -64036,8 +63635,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64065,8 +63664,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -64097,8 +63696,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64129,8 +63728,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -64162,8 +63761,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64192,8 +63791,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Success response @@ -64233,8 +63832,8 @@ paths: in: query schema: type: string - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -64278,8 +63877,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -64311,8 +63910,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -64386,8 +63985,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: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -64423,8 +64022,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: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -64454,8 +64053,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': @@ -64485,8 +64084,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '204': @@ -64513,8 +64112,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': *81 @@ -64539,8 +64138,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: - - *466 - - *467 + - *462 + - *463 - *75 requestBody: required: true @@ -64589,8 +64188,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: - - *466 - - *467 + - *462 + - *463 - *75 requestBody: required: true @@ -64640,8 +64239,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: - - *466 - - *467 + - *462 + - *463 - *75 responses: '200': *290 @@ -64671,8 +64270,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: - - *466 - - *467 + - *462 + - *463 - *75 - *291 responses: @@ -64702,9 +64301,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: - - *466 - - *467 - - &505 + - *462 + - *463 + - &501 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. @@ -64712,7 +64311,7 @@ paths: required: false schema: type: string - - &506 + - &502 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -64720,7 +64319,7 @@ paths: required: false schema: type: string - - &507 + - &503 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -64729,7 +64328,7 @@ paths: required: false schema: type: string - - &508 + - &504 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 @@ -64756,7 +64355,7 @@ paths: - pending - *17 - *19 - - &509 + - &505 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)." @@ -64765,7 +64364,7 @@ paths: schema: type: string format: date-time - - &488 + - &484 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -64774,13 +64373,13 @@ paths: schema: type: boolean default: false - - &510 + - &506 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &511 + - &507 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -64803,7 +64402,7 @@ paths: type: integer workflow_runs: type: array - items: &489 + items: &485 title: Workflow Run description: An invocation of a workflow type: object @@ -64951,7 +64550,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &533 + properties: &529 id: type: string description: SHA for the commit @@ -65002,7 +64601,7 @@ paths: - name - email nullable: true - required: &534 + required: &530 - id - tree_id - message @@ -65049,7 +64648,7 @@ paths: - workflow_url - pull_requests examples: - default: &512 + default: &508 value: total_count: 1 workflow_runs: @@ -65285,24 +64884,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *466 - - *467 - - &490 + - *462 + - *463 + - &486 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *488 + - *484 responses: '200': description: Response content: application/json: - schema: *489 + schema: *485 examples: - default: &493 + default: &489 value: id: 30433642 name: Build @@ -65543,9 +65142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -65568,9 +65167,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65689,9 +65288,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '201': description: Response @@ -65724,12 +65323,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 - *17 - *19 - - *491 + - *487 responses: '200': description: Response @@ -65745,9 +65344,9 @@ paths: type: integer artifacts: type: array - items: *475 + items: *471 examples: - default: *492 + default: *488 headers: Link: *47 x-github: @@ -65771,25 +65370,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *466 - - *467 - - *490 - - &494 + - *462 + - *463 + - *486 + - &490 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *488 + - *484 responses: '200': description: Response content: application/json: - schema: *489 + schema: *485 examples: - default: *493 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65812,10 +65411,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: - - *466 - - *467 + - *462 + - *463 + - *486 - *490 - - *494 - *17 - *19 responses: @@ -65833,9 +65432,9 @@ paths: type: integer jobs: type: array - items: *495 + items: *491 examples: - default: &496 + default: &492 value: total_count: 1 jobs: @@ -65948,10 +65547,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *466 - - *467 + - *462 + - *463 + - *486 - *490 - - *494 responses: '302': description: Response @@ -65979,9 +65578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '202': description: Response @@ -66014,9 +65613,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -66083,9 +65682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '202': description: Response @@ -66118,9 +65717,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 - 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 @@ -66150,9 +65749,9 @@ paths: type: integer jobs: type: array - items: *495 + items: *491 examples: - default: *496 + default: *492 headers: Link: *47 x-github: @@ -66177,9 +65776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '302': description: Response @@ -66206,9 +65805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -66235,9 +65834,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -66297,7 +65896,7 @@ paths: items: type: object properties: - type: &623 + type: &621 type: string description: The type of reviewer. enum: @@ -66382,9 +65981,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -66431,7 +66030,7 @@ paths: application/json: schema: type: array - items: &608 + items: &606 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -66537,7 +66136,7 @@ paths: - created_at - updated_at examples: - default: &609 + default: &607 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -66593,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -66639,9 +66238,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: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -66695,9 +66294,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *466 - - *467 - - *490 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -66834,8 +66433,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -66853,9 +66452,9 @@ paths: type: integer secrets: type: array - items: *497 + items: *493 examples: - default: *498 + default: *494 headers: Link: *47 x-github: @@ -66880,16 +66479,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *499 + schema: *495 examples: - default: *500 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66911,17 +66510,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *497 + schema: *493 examples: - default: &636 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -66947,8 +66546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -67006,8 +66605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -67033,9 +66632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *466 - - *467 - - *484 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -67052,9 +66651,9 @@ paths: type: integer variables: type: array - items: *501 + items: *497 examples: - default: *502 + default: *498 headers: Link: *47 x-github: @@ -67077,8 +66676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -67130,17 +66729,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 responses: '200': description: Response content: application/json: - schema: *501 + schema: *497 examples: - default: &637 + default: &635 value: name: USERNAME value: octocat @@ -67166,8 +66765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 requestBody: required: true @@ -67210,8 +66809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 responses: '204': @@ -67237,8 +66836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -67256,7 +66855,7 @@ paths: type: integer workflows: type: array - items: &503 + items: &499 title: Workflow description: A GitHub Actions workflow type: object @@ -67363,9 +66962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *466 - - *467 - - &504 + - *462 + - *463 + - &500 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67380,7 +66979,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *499 examples: default: value: @@ -67413,9 +67012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67440,9 +67039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67493,9 +67092,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -67522,19 +67121,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: - - *466 - - *467 + - *462 + - *463 + - *500 + - *501 + - *502 + - *503 - *504 + - *17 + - *19 - *505 + - *484 - *506 - *507 - - *508 - - *17 - - *19 - - *509 - - *488 - - *510 - - *511 responses: '200': description: Response @@ -67550,9 +67149,9 @@ paths: type: integer workflow_runs: type: array - items: *489 + items: *485 examples: - default: *512 + default: *508 headers: Link: *47 x-github: @@ -67585,9 +67184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *466 - - *467 - - *504 + - *462 + - *463 + - *500 responses: '200': description: Response @@ -67648,8 +67247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *466 - - *467 + - *462 + - *463 - *110 - *17 - *108 @@ -67813,8 +67412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -67851,8 +67450,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: - - *466 - - *467 + - *462 + - *463 - name: assignee in: path required: true @@ -67888,8 +67487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -68001,8 +67600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *108 - *109 @@ -68059,7 +67658,7 @@ paths: initiator: type: string examples: - default: *513 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68079,8 +67678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -68088,7 +67687,7 @@ paths: application/json: schema: type: array - items: &514 + items: &510 title: Autolink reference description: An autolink reference. type: object @@ -68142,8 +67741,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -68182,9 +67781,9 @@ paths: description: response content: application/json: - schema: *514 + schema: *510 examples: - default: &515 + default: &511 value: id: 1 key_prefix: TICKET- @@ -68215,9 +67814,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: - - *466 - - *467 - - &516 + - *462 + - *463 + - &512 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68229,9 +67828,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *510 examples: - default: *515 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -68251,9 +67850,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: - - *466 - - *467 - - *516 + - *462 + - *463 + - *512 responses: '204': description: Response @@ -68277,8 +67876,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response if Dependabot is enabled @@ -68326,8 +67925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -68348,8 +67947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -68369,8 +67968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *466 - - *467 + - *462 + - *463 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68408,7 +68007,7 @@ paths: - url protected: type: boolean - protection: &518 + protection: &514 title: Branch Protection description: Branch Protection type: object @@ -68450,7 +68049,7 @@ paths: required: - contexts - checks - enforce_admins: &521 + enforce_admins: &517 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -68465,7 +68064,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &523 + required_pull_request_reviews: &519 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -68541,7 +68140,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &520 + restrictions: &516 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -68818,9 +68417,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *466 - - *467 - - &519 + - *462 + - *463 + - &515 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). @@ -68834,14 +68433,14 @@ paths: description: Response content: application/json: - schema: &529 + schema: &525 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &581 + commit: &579 title: Commit description: Commit type: object @@ -68875,7 +68474,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &517 + properties: &513 name: type: string example: '"Chris Wanstrath"' @@ -68891,7 +68490,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true message: type: string @@ -68912,7 +68511,7 @@ paths: required: - sha - url - verification: &643 + verification: &641 title: Verification type: object properties: @@ -68982,7 +68581,7 @@ paths: type: integer files: type: array - items: &594 + items: &592 title: Diff Entry description: Diff Entry type: object @@ -69066,7 +68665,7 @@ paths: - self protected: type: boolean - protection: *518 + protection: *514 protection_url: type: string format: uri @@ -69173,7 +68772,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *472 + '301': *468 '404': *6 x-github: githubCloudOnly: false @@ -69195,15 +68794,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *518 + schema: *514 examples: default: value: @@ -69397,9 +68996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69654,7 +69253,7 @@ paths: url: type: string format: uri - required_status_checks: &526 + required_status_checks: &522 title: Status Check Policy description: Status Check Policy type: object @@ -69806,7 +69405,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *520 + restrictions: *516 required_conversation_resolution: type: object properties: @@ -69918,9 +69517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69945,17 +69544,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: &522 + default: &518 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -69977,17 +69576,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: *522 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70006,9 +69605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70033,17 +69632,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *523 + schema: *519 examples: - default: &524 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70139,9 +69738,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70239,9 +69838,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *519 examples: - default: *524 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -70262,9 +69861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70291,17 +69890,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: &525 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70324,17 +69923,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *521 + schema: *517 examples: - default: *525 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -70354,9 +69953,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70381,17 +69980,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *526 + schema: *522 examples: - default: &527 + default: &523 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -70417,9 +70016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70471,9 +70070,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *522 examples: - default: *527 + default: *523 '404': *6 '422': *15 x-github: @@ -70495,9 +70094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70521,9 +70120,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70557,9 +70156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70626,9 +70225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70692,9 +70291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -70760,15 +70359,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *520 + schema: *516 examples: default: value: @@ -70859,9 +70458,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -70884,9 +70483,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70896,7 +70495,7 @@ paths: type: array items: *5 examples: - default: &528 + default: &524 value: - id: 1 slug: octoapp @@ -70953,9 +70552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70989,7 +70588,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71010,9 +70609,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71046,7 +70645,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71067,9 +70666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71103,7 +70702,7 @@ paths: type: array items: *5 examples: - default: *528 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -71125,9 +70724,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -71157,9 +70756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -71218,9 +70817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -71279,9 +70878,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -71340,9 +70939,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: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -71376,9 +70975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71436,9 +71035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71496,9 +71095,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71558,9 +71157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -71582,7 +71181,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *525 examples: default: value: @@ -71696,8 +71295,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -71733,8 +71332,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71807,8 +71406,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -71848,8 +71447,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71919,8 +71518,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -71991,8 +71590,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *462 + - *463 - name: bypass_response_id in: path required: true @@ -72025,8 +71624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -72305,7 +71904,7 @@ paths: description: Response content: application/json: - schema: &530 + schema: &526 title: CheckRun description: A check performed on the code of a given code change type: object @@ -72705,9 +72304,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *466 - - *467 - - &531 + - *462 + - *463 + - &527 name: check_run_id description: The unique identifier of the check run. in: path @@ -72719,9 +72318,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *526 examples: - default: &532 + default: &528 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -72821,9 +72420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 requestBody: required: true content: @@ -73063,9 +72662,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *526 examples: - default: *532 + default: *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73085,9 +72684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 - *17 - *19 responses: @@ -73182,9 +72781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *466 - - *467 - - *531 + - *462 + - *463 + - *527 responses: '201': description: Response @@ -73228,8 +72827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -73251,7 +72850,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &535 + schema: &531 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73341,8 +72940,8 @@ paths: title: Simple Commit description: A commit. type: object - properties: *533 - required: *534 + properties: *529 + required: *530 latest_check_runs_count: type: integer check_runs_url: @@ -73370,7 +72969,7 @@ paths: - check_runs_url - pull_requests examples: - default: &536 + default: &532 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -73661,9 +73260,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *535 + schema: *531 examples: - default: *536 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73682,8 +73281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -73992,9 +73591,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *466 - - *467 - - &537 + - *462 + - *463 + - &533 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74006,9 +73605,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *531 examples: - default: *536 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74031,17 +73630,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: - - *466 - - *467 - - *537 - - &587 + - *462 + - *463 + - *533 + - &585 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &588 + - &586 name: status description: Returns check runs with the specified `status`. in: query @@ -74080,9 +73679,9 @@ paths: type: integer check_runs: type: array - items: *530 + items: *526 examples: - default: &589 + default: &587 value: total_count: 1 check_runs: @@ -74184,9 +73783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *466 - - *467 - - *537 + - *462 + - *463 + - *533 responses: '201': description: Response @@ -74219,21 +73818,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: - - *466 - - *467 + - *462 + - *463 - *316 - *317 - *19 - *17 - - &553 + - &549 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *538 - - &554 + schema: *534 + - &550 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74264,7 +73863,7 @@ paths: be returned. in: query required: false - schema: *539 + schema: *535 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -74288,7 +73887,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *540 + instances_url: *536 state: *113 fixed_at: *137 dismissed_by: @@ -74299,11 +73898,11 @@ paths: required: *21 nullable: true dismissed_at: *136 - dismissed_reason: *541 - dismissed_comment: *542 - rule: *543 - tool: *544 - most_recent_instance: *545 + dismissed_reason: *537 + dismissed_comment: *538 + rule: *539 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -74429,7 +74028,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &546 + '403': &542 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -74456,9 +74055,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: - - *466 - - *467 - - &547 + - *462 + - *463 + - &543 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -74472,7 +74071,7 @@ paths: description: Response content: application/json: - schema: &548 + schema: &544 type: object properties: number: *127 @@ -74480,7 +74079,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *540 + instances_url: *536 state: *113 fixed_at: *137 dismissed_by: @@ -74491,8 +74090,8 @@ paths: required: *21 nullable: true dismissed_at: *136 - dismissed_reason: *541 - dismissed_comment: *542 + dismissed_reason: *537 + dismissed_comment: *538 rule: type: object properties: @@ -74546,8 +74145,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *544 - most_recent_instance: *545 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -74646,7 +74245,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -74666,9 +74265,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: true content: @@ -74683,8 +74282,8 @@ paths: enum: - open - dismissed - dismissed_reason: *541 - dismissed_comment: *542 + dismissed_reason: *537 + dismissed_comment: *538 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -74712,7 +74311,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *544 examples: default: value: @@ -74788,7 +74387,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &552 + '403': &548 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -74815,15 +74414,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 responses: '200': description: Response content: application/json: - schema: &549 + schema: &545 type: object properties: status: @@ -74849,13 +74448,13 @@ paths: - description - started_at examples: - default: &550 + default: &546 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &551 + '400': &547 description: Bad Request content: application/json: @@ -74866,7 +74465,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': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -74891,29 +74490,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 responses: '200': description: OK content: application/json: - schema: *549 + schema: *545 examples: - default: *550 + default: *546 '202': description: Accepted content: application/json: - schema: *549 + schema: *545 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *551 + '400': *547 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -74945,9 +74544,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: false content: @@ -74992,8 +74591,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *551 - '403': *552 + '400': *547 + '403': *548 '404': *6 '422': description: Unprocessable Entity @@ -75017,13 +74616,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *19 - *17 - - *553 - - *554 + - *549 + - *550 responses: '200': description: Response @@ -75034,10 +74633,10 @@ paths: items: type: object properties: - ref: *538 - analysis_key: *555 - environment: *556 - category: *557 + ref: *534 + analysis_key: *551 + environment: *552 + category: *553 state: type: string description: State of a code scanning alert instance. @@ -75052,7 +74651,7 @@ paths: properties: text: type: string - location: *558 + location: *554 html_url: type: string classifications: @@ -75060,7 +74659,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: *559 + items: *555 examples: default: value: @@ -75099,7 +74698,7 @@ paths: end_column: 50 classifications: - source - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75133,25 +74732,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: - - *466 - - *467 + - *462 + - *463 - *316 - *317 - *19 - *17 - - *554 + - *550 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *538 + schema: *534 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &560 + schema: &556 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -75172,23 +74771,23 @@ paths: application/json: schema: type: array - items: &561 + items: &557 type: object properties: - ref: *538 - commit_sha: &569 + ref: *534 + commit_sha: &565 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: *555 + analysis_key: *551 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *557 + category: *553 error: type: string example: error reading field xyz @@ -75212,8 +74811,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *560 - tool: *544 + sarif_id: *556 + tool: *540 deletable: type: boolean warning: @@ -75274,7 +74873,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75310,8 +74909,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: - - *466 - - *467 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75324,7 +74923,7 @@ paths: description: Response content: application/json: - schema: *561 + schema: *557 examples: response: summary: application/json response @@ -75378,7 +74977,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *546 + '403': *542 '404': *6 '422': description: Response if analysis could not be processed @@ -75465,8 +75064,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: - - *466 - - *467 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75519,7 +75118,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': *552 + '403': *548 '404': *6 '503': *195 x-github: @@ -75541,8 +75140,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -75550,7 +75149,7 @@ paths: application/json: schema: type: array - items: &562 + items: &558 title: CodeQL Database description: A CodeQL database. type: object @@ -75661,7 +75260,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': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75690,8 +75289,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: - - *466 - - *467 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -75703,7 +75302,7 @@ paths: description: Response content: application/json: - schema: *562 + schema: *558 examples: default: value: @@ -75735,9 +75334,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': &596 + '302': &594 description: Found - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -75759,8 +75358,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *466 - - *467 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -75770,7 +75369,7 @@ paths: responses: '204': description: Response - '403': *552 + '403': *548 '404': *6 '503': *195 x-github: @@ -75798,8 +75397,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -75808,7 +75407,7 @@ paths: type: object additionalProperties: false properties: - language: &563 + language: &559 type: string description: The language targeted by the CodeQL query enum: @@ -75888,7 +75487,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &567 + schema: &563 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -75898,7 +75497,7 @@ paths: description: The ID of the variant analysis. controller_repo: *119 actor: *4 - query_language: *563 + query_language: *559 query_pack_url: type: string description: The download url for the query pack. @@ -75945,7 +75544,7 @@ paths: items: type: object properties: - repository: &564 + repository: &560 title: Repository Identifier description: Repository Identifier type: object @@ -75981,7 +75580,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &568 + analysis_status: &564 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76013,7 +75612,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &565 + access_mismatch_repos: &561 type: object properties: repository_count: @@ -76027,7 +75626,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: *564 + items: *560 required: - repository_count - repositories @@ -76049,8 +75648,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *565 - over_limit_repos: *565 + no_codeql_db_repos: *561 + over_limit_repos: *561 required: - access_mismatch_repos - not_found_repos @@ -76066,7 +75665,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &566 + value: &562 summary: Default response value: id: 1 @@ -76212,10 +75811,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *566 + value: *562 repository_lists: summary: Response for a successful variant analysis submission - value: *566 + value: *562 '404': *6 '422': description: Unable to process variant analysis submission @@ -76243,8 +75842,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: - - *466 - - *467 + - *462 + - *463 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76256,9 +75855,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *563 examples: - default: *566 + default: *562 '404': *6 '503': *195 x-github: @@ -76281,7 +75880,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: - - *466 + - *462 - name: repo in: path description: The name of the controller repository. @@ -76316,7 +75915,7 @@ paths: type: object properties: repository: *119 - analysis_status: *568 + analysis_status: *564 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -76441,8 +76040,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -76527,7 +76126,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *546 + '403': *542 '404': *6 '503': *195 x-github: @@ -76548,8 +76147,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -76641,7 +76240,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *552 + '403': *548 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -76712,8 +76311,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -76721,7 +76320,7 @@ paths: schema: type: object properties: - commit_sha: *569 + commit_sha: *565 ref: type: string description: |- @@ -76779,7 +76378,7 @@ paths: schema: type: object properties: - id: *560 + id: *556 url: type: string description: The REST API URL for checking the status of the upload. @@ -76793,7 +76392,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': *552 + '403': *548 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -76816,8 +76415,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: - - *466 - - *467 + - *462 + - *463 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -76863,7 +76462,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': *546 + '403': *542 '404': description: Not Found if the sarif id does not match any upload '503': *195 @@ -76888,8 +76487,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -76970,8 +76569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *466 - - *467 + - *462 + - *463 - 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 @@ -77091,8 +76690,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -77406,8 +77005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -77472,7 +77071,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -77480,7 +77079,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '400': *14 '401': *25 '403': *29 @@ -77509,8 +77108,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -77574,8 +77173,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: - - *466 - - *467 + - *462 + - *463 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -77614,8 +77213,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *571 - required: *572 + properties: *567 + required: *568 examples: default: &815 value: @@ -77657,8 +77256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *466 - - *467 + - *462 + - *463 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -77742,8 +77341,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: - - *466 - - *467 + - *462 + - *463 - 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 @@ -77809,8 +77408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -77828,7 +77427,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &572 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -77848,7 +77447,7 @@ paths: - created_at - updated_at examples: - default: *573 + default: *569 headers: Link: *47 x-github: @@ -77871,16 +77470,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *574 + schema: *570 examples: - default: *575 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -77900,17 +77499,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *576 + schema: *572 examples: - default: *577 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77930,8 +77529,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: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -77984,8 +77583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -78014,8 +77613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *466 - - *467 + - *462 + - *463 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78057,7 +77656,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &578 + properties: &574 login: type: string example: octocat @@ -78150,7 +77749,7 @@ paths: user_view_type: type: string example: public - required: &579 + required: &575 - avatar_url - events_url - followers_url @@ -78224,8 +77823,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: - - *466 - - *467 + - *462 + - *463 - *142 responses: '204': @@ -78272,8 +77871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *466 - - *467 + - *462 + - *463 - *142 requestBody: required: false @@ -78300,7 +77899,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &656 + schema: &654 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -78529,8 +78128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *466 - - *467 + - *462 + - *463 - *142 responses: '204': @@ -78562,8 +78161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *466 - - *467 + - *462 + - *463 - *142 responses: '200': @@ -78584,8 +78183,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *578 - required: *579 + properties: *574 + required: *575 nullable: true required: - permission @@ -78640,8 +78239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -78651,7 +78250,7 @@ paths: application/json: schema: type: array - items: &580 + items: &576 title: Commit Comment description: Commit Comment type: object @@ -78709,7 +78308,7 @@ paths: - created_at - updated_at examples: - default: &583 + default: &581 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78768,17 +78367,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': description: Response content: application/json: - schema: *580 + schema: *576 examples: - default: &584 + default: &582 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78835,8 +78434,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -78859,7 +78458,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *576 examples: default: value: @@ -78910,8 +78509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -78933,8 +78532,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -78961,9 +78560,74 @@ paths: application/json: schema: type: array - items: *457 + items: &577 + title: Reaction + description: Reactions to conversations provide a way to help people + express their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *459 + default: &658 + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' headers: Link: *47 '404': *6 @@ -78984,8 +78648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -79018,16 +78682,40 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: &578 + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -79049,10 +78737,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - &659 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -79101,8 +78795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *466 - - *467 + - *462 + - *463 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79158,7 +78852,7 @@ paths: application/json: schema: type: array - items: *581 + items: *579 examples: default: &708 value: @@ -79254,9 +78948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *466 - - *467 - - &582 + - *462 + - *463 + - &580 name: commit_sha description: The SHA of the commit. in: path @@ -79328,9 +79022,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79340,9 +79034,9 @@ paths: application/json: schema: type: array - items: *580 + items: *576 examples: - default: *583 + default: *581 headers: Link: *47 x-github: @@ -79370,9 +79064,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 requestBody: required: true content: @@ -79407,9 +79101,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *576 examples: - default: *584 + default: *582 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79437,9 +79131,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: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79449,7 +79143,7 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: default: &700 value: @@ -79988,11 +79682,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 - - &586 + - &584 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)" @@ -80007,7 +79701,7 @@ paths: description: Response content: application/json: - schema: *581 + schema: *579 examples: default: &685 value: @@ -80122,11 +79816,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: - - *466 - - *467 + - *462 + - *463 + - *584 + - *585 - *586 - - *587 - - *588 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80160,9 +79854,9 @@ paths: type: integer check_runs: type: array - items: *530 + items: *526 examples: - default: *589 + default: *587 headers: Link: *47 x-github: @@ -80187,9 +79881,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: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80197,7 +79891,7 @@ paths: schema: type: integer example: 1 - - *587 + - *585 - *17 - *19 responses: @@ -80215,7 +79909,7 @@ paths: type: integer check_suites: type: array - items: *535 + items: *531 examples: default: value: @@ -80415,9 +80109,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: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - *17 - *19 responses: @@ -80615,9 +80309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *466 - - *467 - - *586 + - *462 + - *463 + - *584 - *17 - *19 responses: @@ -80708,7 +80402,7 @@ paths: site_admin: false headers: Link: *47 - '301': *472 + '301': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80736,8 +80430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -80766,20 +80460,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *590 - required: *591 + properties: *588 + required: *589 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &592 + properties: &590 url: type: string format: uri html_url: type: string format: uri - required: &593 + required: &591 - url - html_url nullable: true @@ -80793,26 +80487,26 @@ paths: contributing: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true readme: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true issue_template: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true pull_request_template: title: Community Health File type: object - properties: *592 - required: *593 + properties: *590 + required: *591 nullable: true required: - code_of_conduct @@ -80939,8 +80633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 - name: basehead @@ -80983,8 +80677,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *581 - merge_base_commit: *581 + base_commit: *579 + merge_base_commit: *579 status: type: string enum: @@ -81004,10 +80698,10 @@ paths: example: 6 commits: type: array - items: *581 + items: *579 files: type: array - items: *594 + items: *592 required: - url - html_url @@ -81293,8 +80987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -81437,7 +81131,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &595 + response-if-content-is-a-file: &593 summary: Response if content is a file value: type: file @@ -81770,7 +81464,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *595 + response-if-content-is-a-file: *593 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -81839,7 +81533,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *596 + '302': *594 '304': *37 x-github: githubCloudOnly: false @@ -81862,8 +81556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -81956,7 +81650,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &595 title: File Commit description: File Commit type: object @@ -82108,7 +81802,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *595 examples: example-for-creating-a-file: value: @@ -82162,7 +81856,7 @@ paths: schema: oneOf: - *3 - - &638 + - &636 description: Repository rule violation was detected type: object properties: @@ -82215,8 +81909,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *466 - - *467 + - *462 + - *463 - name: path description: path parameter in: path @@ -82277,7 +81971,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *595 examples: default: value: @@ -82332,8 +82026,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *466 - - *467 + - *462 + - *463 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -82456,8 +82150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *332 - *333 - *334 @@ -82469,7 +82163,7 @@ paths: schema: type: string - *336 - - *598 + - *596 - *337 - *338 - *110 @@ -82490,7 +82184,7 @@ paths: application/json: schema: type: array - items: &602 + items: &600 type: object description: A Dependabot alert. properties: @@ -82536,7 +82230,7 @@ paths: - unknown - direct - transitive - security_advisory: *599 + security_advisory: *597 security_vulnerability: *131 url: *132 html_url: *133 @@ -82567,8 +82261,8 @@ paths: nullable: true maxLength: 280 fixed_at: *137 - auto_dismissed_at: *600 - dismissal_request: *601 + auto_dismissed_at: *598 + dismissal_request: *599 required: - number - state @@ -82798,9 +82492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *466 - - *467 - - &603 + - *462 + - *463 + - &601 name: alert_number in: path description: |- @@ -82815,7 +82509,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *600 examples: default: value: @@ -82928,9 +82622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *466 - - *467 - - *603 + - *462 + - *463 + - *601 requestBody: required: true content: @@ -82975,7 +82669,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *600 examples: default: value: @@ -83104,8 +82798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -83123,7 +82817,7 @@ paths: type: integer secrets: type: array - items: &606 + items: &604 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83176,16 +82870,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *604 + schema: *602 examples: - default: *605 + default: *603 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83205,15 +82899,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '200': description: Response content: application/json: - schema: *606 + schema: *604 examples: default: value: @@ -83239,8 +82933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 requestBody: required: true @@ -83293,8 +82987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *466 - - *467 + - *462 + - *463 - *293 responses: '204': @@ -83317,8 +83011,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: - - *466 - - *467 + - *462 + - *463 - 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 @@ -83478,8 +83172,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -83718,8 +83412,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -83794,7 +83488,7 @@ paths: - version - url additionalProperties: false - metadata: &607 + metadata: &605 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83827,7 +83521,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *607 + metadata: *605 resolved: type: object description: A collection of resolved package dependencies. @@ -83840,7 +83534,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *607 + metadata: *605 relationship: type: string description: A notation of whether a dependency is requested @@ -83969,8 +83663,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *466 - - *467 + - *462 + - *463 - name: sha description: The SHA recorded at creation time. in: query @@ -84010,9 +83704,9 @@ paths: application/json: schema: type: array - items: *608 + items: *606 examples: - default: *609 + default: *607 headers: Link: *47 x-github: @@ -84078,8 +83772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -84160,7 +83854,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *606 examples: simple-example: summary: Simple example @@ -84233,9 +83927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *466 - - *467 - - &610 + - *462 + - *463 + - &608 name: deployment_id description: deployment_id parameter in: path @@ -84247,7 +83941,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *606 examples: default: value: @@ -84312,9 +84006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 responses: '204': description: Response @@ -84336,9 +84030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 - *17 - *19 responses: @@ -84348,7 +84042,7 @@ paths: application/json: schema: type: array - items: &611 + items: &609 title: Deployment Status description: The status of a deployment. type: object @@ -84509,9 +84203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 requestBody: required: true content: @@ -84586,9 +84280,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *609 examples: - default: &612 + default: &610 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -84644,9 +84338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *466 - - *467 - - *610 + - *462 + - *463 + - *608 - name: status_id in: path required: true @@ -84657,9 +84351,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *609 examples: - default: *612 + default: *610 '404': *6 x-github: githubCloudOnly: false @@ -84686,12 +84380,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 + - *611 + - *612 - *613 - *614 - - *615 - - *616 - *17 - *19 responses: @@ -84701,9 +84395,9 @@ paths: application/json: schema: type: array - items: *617 + items: *615 examples: - default: *618 + default: *616 '404': *6 '403': *29 '500': *40 @@ -84727,8 +84421,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84740,7 +84434,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *617 + schema: *615 examples: default: value: @@ -84796,8 +84490,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84856,12 +84550,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 + - *611 + - *612 - *613 - *614 - - *615 - - *616 - *17 - *19 responses: @@ -84871,9 +84565,9 @@ paths: application/json: schema: type: array - items: *619 + items: *617 examples: - default: *620 + default: *618 '404': *6 '403': *29 '500': *40 @@ -84897,8 +84591,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -84910,7 +84604,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *619 + schema: *617 examples: default: value: @@ -84961,8 +84655,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85000,7 +84694,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *619 + schema: *617 examples: default: value: @@ -85051,8 +84745,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85123,8 +84817,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85157,8 +84851,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - *103 - *104 - *105 @@ -85172,9 +84866,9 @@ paths: application/json: schema: type: array - items: *621 + items: *619 examples: - default: *622 + default: *620 '404': *6 '403': *29 '500': *40 @@ -85199,8 +84893,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85212,7 +84906,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *621 + schema: *619 examples: default: value: @@ -85270,8 +84964,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: alert_number in: path required: true @@ -85340,8 +85034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -85398,8 +85092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -85416,7 +85110,7 @@ paths: type: integer environments: type: array - items: &624 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -85468,7 +85162,7 @@ paths: type: type: string example: wait_timer - wait_timer: &626 + wait_timer: &624 type: integer example: 30 description: The amount of time to delay a job after @@ -85505,7 +85199,7 @@ paths: items: type: object properties: - type: *623 + type: *621 reviewer: anyOf: - *4 @@ -85529,7 +85223,7 @@ paths: - id - node_id - type - deployment_branch_policy: &627 + deployment_branch_policy: &625 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -85645,9 +85339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *466 - - *467 - - &625 + - *462 + - *463 + - &623 name: environment_name in: path required: true @@ -85660,9 +85354,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: &628 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -85746,9 +85440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: false content: @@ -85757,7 +85451,7 @@ paths: type: object nullable: true properties: - wait_timer: *626 + wait_timer: *624 prevent_self_review: type: boolean example: false @@ -85774,13 +85468,13 @@ paths: items: type: object properties: - type: *623 + type: *621 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *627 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -85800,9 +85494,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *628 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -85826,9 +85520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 responses: '204': description: Default response @@ -85853,9 +85547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *17 - *19 responses: @@ -85873,7 +85567,7 @@ paths: example: 2 branch_policies: type: array - items: &629 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -85930,9 +85624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: true content: @@ -85978,9 +85672,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - example-wildcard: &630 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86022,10 +85716,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - &631 + - *462 + - *463 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -86037,9 +85731,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86058,10 +85752,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - *631 + - *462 + - *463 + - *623 + - *629 requestBody: required: true content: @@ -86089,9 +85783,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *627 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86110,10 +85804,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *466 - - *467 - - *625 - - *631 + - *462 + - *463 + - *623 + - *629 responses: '204': description: Response @@ -86138,9 +85832,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 responses: '200': description: List of deployment protection rules @@ -86156,7 +85850,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &632 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -86175,7 +85869,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &633 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86274,9 +85968,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 requestBody: content: application/json: @@ -86297,9 +85991,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *632 + schema: *630 examples: - default: &634 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86334,9 +86028,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: - - *625 - - *467 - - *466 + - *623 + - *463 + - *462 - *19 - *17 responses: @@ -86355,7 +86049,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *633 + items: *631 examples: default: value: @@ -86390,10 +86084,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: - - *466 - - *467 - - *625 - - &635 + - *462 + - *463 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86405,9 +86099,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *630 examples: - default: *634 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86428,10 +86122,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: - - *625 - - *467 - - *466 - - *635 + - *623 + - *463 + - *462 + - *633 responses: '204': description: Response @@ -86457,9 +86151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *17 - *19 responses: @@ -86477,9 +86171,9 @@ paths: type: integer secrets: type: array - items: *497 + items: *493 examples: - default: *498 + default: *494 headers: Link: *47 x-github: @@ -86504,17 +86198,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 responses: '200': description: Response content: application/json: - schema: *499 + schema: *495 examples: - default: *500 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86536,18 +86230,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 responses: '200': description: Response content: application/json: - schema: *497 + schema: *493 examples: - default: *636 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86569,9 +86263,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 requestBody: required: true @@ -86629,9 +86323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *293 responses: '204': @@ -86657,10 +86351,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *466 - - *467 - - *625 - - *484 + - *462 + - *463 + - *623 + - *480 - *19 responses: '200': @@ -86677,9 +86371,9 @@ paths: type: integer variables: type: array - items: *501 + items: *497 examples: - default: *502 + default: *498 headers: Link: *47 x-github: @@ -86702,9 +86396,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 requestBody: required: true content: @@ -86756,18 +86450,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *466 - - *467 - - *625 + - *462 + - *463 + - *623 - *296 responses: '200': description: Response content: application/json: - schema: *501 + schema: *497 examples: - default: *637 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86788,10 +86482,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 - - *625 + - *623 requestBody: required: true content: @@ -86833,10 +86527,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *466 - - *467 + - *462 + - *463 - *296 - - *625 + - *623 responses: '204': description: Response @@ -86858,8 +86552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -86927,8 +86621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *466 - - *467 + - *462 + - *463 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87087,8 +86781,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -87120,9 +86814,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 '400': *14 '422': *15 '403': *29 @@ -87143,8 +86837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87204,7 +86898,7 @@ paths: schema: oneOf: - *258 - - *638 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87229,8 +86923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *466 - - *467 + - *462 + - *463 - name: file_sha in: path required: true @@ -87329,8 +87023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87439,7 +87133,7 @@ paths: description: Response content: application/json: - schema: &639 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -87653,15 +87347,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *466 - - *467 - - *582 + - *462 + - *463 + - *580 responses: '200': description: Response content: application/json: - schema: *639 + schema: *637 examples: default: value: @@ -87717,9 +87411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *466 - - *467 - - &640 + - *462 + - *463 + - &638 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. @@ -87736,7 +87430,7 @@ paths: application/json: schema: type: array - items: &641 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -87811,17 +87505,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 responses: '200': description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: &642 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -87850,8 +87544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -87880,9 +87574,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: *642 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -87908,9 +87602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 requestBody: required: true content: @@ -87939,9 +87633,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *639 examples: - default: *642 + default: *640 '422': *15 '409': *118 x-github: @@ -87959,9 +87653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *466 - - *467 - - *640 + - *462 + - *463 + - *638 responses: '204': description: Response @@ -88016,8 +87710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -88084,7 +87778,7 @@ paths: description: Response content: application/json: - schema: &644 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -88135,7 +87829,7 @@ paths: - sha - type - url - verification: *643 + verification: *641 required: - sha - url @@ -88145,7 +87839,7 @@ paths: - tag - message examples: - default: &645 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88218,8 +87912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *466 - - *467 + - *462 + - *463 - name: tag_sha in: path required: true @@ -88230,9 +87924,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *642 examples: - default: *645 + default: *643 '404': *6 '409': *118 x-github: @@ -88256,8 +87950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -88330,7 +88024,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88426,8 +88120,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *466 - - *467 + - *462 + - *463 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -88450,7 +88144,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *644 examples: default-response: summary: Default response @@ -88509,8 +88203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -88520,7 +88214,7 @@ paths: application/json: schema: type: array - items: &647 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -88648,8 +88342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -88701,9 +88395,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: &648 + default: &646 value: type: Repository id: 12345678 @@ -88751,17 +88445,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '200': description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: *648 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -88781,8 +88475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 requestBody: required: true @@ -88828,9 +88522,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *645 examples: - default: *648 + default: *646 '422': *15 '404': *6 x-github: @@ -88851,8 +88545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -88877,8 +88571,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: - - *466 - - *467 + - *462 + - *463 - *348 responses: '200': @@ -88906,8 +88600,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: - - *466 - - *467 + - *462 + - *463 - *348 requestBody: required: false @@ -88952,8 +88646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 - *17 - *349 @@ -88985,8 +88679,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: - - *466 - - *467 + - *462 + - *463 - *348 - *16 responses: @@ -89015,8 +88709,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: - - *466 - - *467 + - *462 + - *463 - *348 - *16 responses: @@ -89040,8 +88734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -89067,8 +88761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *466 - - *467 + - *462 + - *463 - *348 responses: '204': @@ -89092,8 +88786,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response if immutable releases are enabled @@ -89139,8 +88833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '409': *118 @@ -89160,8 +88854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '409': *118 @@ -89218,14 +88912,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &649 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -89324,7 +89018,7 @@ paths: - html_url - authors_url examples: - default: &652 + default: &650 value: vcs: subversion use_lfs: true @@ -89340,7 +89034,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': &650 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -89369,8 +89063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -89418,7 +89112,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: default: value: @@ -89443,7 +89137,7 @@ paths: type: string '422': *15 '404': *6 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89471,8 +89165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -89521,7 +89215,7 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: example-1: summary: Example 1 @@ -89569,7 +89263,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': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89592,12 +89286,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89623,8 +89317,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *466 - - *467 + - *462 + - *463 - &836 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -89639,7 +89333,7 @@ paths: application/json: schema: type: array - items: &651 + items: &649 title: Porter Author description: Porter Author type: object @@ -89693,7 +89387,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': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89718,8 +89412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *466 - - *467 + - *462 + - *463 - name: author_id in: path required: true @@ -89749,7 +89443,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *649 examples: default: value: @@ -89762,7 +89456,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89786,8 +89480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89828,7 +89522,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89856,8 +89550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -89884,11 +89578,11 @@ paths: description: Response content: application/json: - schema: *649 + schema: *647 examples: - default: *652 + default: *650 '422': *15 - '503': *650 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89911,8 +89605,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89920,8 +89614,8 @@ paths: application/json: schema: *22 examples: - default: *653 - '301': *472 + default: *651 + '301': *468 '404': *6 x-github: githubCloudOnly: false @@ -89941,8 +89635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -89955,7 +89649,7 @@ paths: properties: {} additionalProperties: false examples: - default: &655 + default: &653 value: limit: collaborators_only origin: repository @@ -89980,13 +89674,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *654 + schema: *652 examples: default: summary: Example request body @@ -90000,7 +89694,7 @@ paths: application/json: schema: *366 examples: - default: *655 + default: *653 '409': description: Response x-github: @@ -90022,8 +89716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -90046,8 +89740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -90057,7 +89751,7 @@ paths: application/json: schema: type: array - items: *656 + items: *654 examples: default: &829 value: @@ -90190,8 +89884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *466 - - *467 + - *462 + - *463 - *370 requestBody: required: false @@ -90221,7 +89915,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *654 examples: default: value: @@ -90352,8 +90046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *466 - - *467 + - *462 + - *463 - *370 responses: '204': @@ -90385,8 +90079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *466 - - *467 + - *462 + - *463 - 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 @@ -90607,7 +90301,7 @@ paths: state_reason: completed headers: Link: *47 - '301': *472 + '301': *468 '422': *15 '404': *6 x-github: @@ -90636,8 +90330,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -90877,7 +90571,7 @@ paths: '422': *15 '503': *195 '404': *6 - '410': *657 + '410': *655 x-github: triggersNotification: true githubCloudOnly: false @@ -90905,8 +90599,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *244 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -90927,7 +90621,7 @@ paths: application/json: schema: type: array - items: *658 + items: *656 examples: default: &665 value: @@ -90987,17 +90681,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: &659 + default: &657 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91051,8 +90745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -91075,9 +90769,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: *659 + default: *657 '422': *15 x-github: githubCloudOnly: false @@ -91095,8 +90789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -91117,8 +90811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -91145,9 +90839,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -91168,8 +90862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -91202,16 +90896,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -91233,10 +90927,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - *659 responses: '204': description: Response @@ -91256,8 +90950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -91618,8 +91312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *466 - - *467 + - *462 + - *463 - name: event_id in: path required: true @@ -91822,7 +91516,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *657 + '410': *655 '403': *29 x-github: githubCloudOnly: false @@ -91856,8 +91550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - &664 name: issue_number description: The number that identifies the issue. @@ -91873,9 +91567,9 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '304': *37 x-github: githubCloudOnly: false @@ -91900,8 +91594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -92012,9 +91706,9 @@ paths: '422': *15 '503': *195 '403': *29 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92032,8 +91726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -92078,8 +91772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: content: @@ -92129,8 +91823,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - name: assignee in: path @@ -92171,8 +91865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *227 - *17 @@ -92184,13 +91878,13 @@ paths: application/json: schema: type: array - items: *658 + items: *656 examples: default: *665 headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92219,8 +91913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -92243,16 +91937,16 @@ paths: description: Response content: application/json: - schema: *658 + schema: *656 examples: - default: *659 + default: *657 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -92280,8 +91974,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -92297,9 +91991,9 @@ paths: default: *666 headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92327,8 +92021,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -92359,9 +92053,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *472 + '301': *468 '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -92392,8 +92086,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *664 - name: issue_id in: path @@ -92409,12 +92103,12 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *657 + '410': *655 x-github: triggersNotification: true githubCloudOnly: false @@ -92440,8 +92134,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -92457,9 +92151,9 @@ paths: default: *666 headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92476,8 +92170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93329,7 +93023,7 @@ paths: color: red headers: Link: *47 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93346,8 +93040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93378,9 +93072,9 @@ paths: default: false headers: Link: *47 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93397,8 +93091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93461,9 +93155,9 @@ paths: items: *219 examples: default: *667 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '422': *15 x-github: githubCloudOnly: false @@ -93480,8 +93174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93545,9 +93239,9 @@ paths: items: *219 examples: default: *667 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 '422': *15 x-github: githubCloudOnly: false @@ -93564,15 +93258,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '204': description: Response - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93591,8 +93285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - name: name in: path @@ -93617,9 +93311,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93639,8 +93333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: false @@ -93669,7 +93363,7 @@ paths: '204': description: Response '403': *29 - '410': *657 + '410': *655 '404': *6 '422': *15 x-github: @@ -93687,8 +93381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '204': @@ -93719,8 +93413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 responses: '200': @@ -93730,9 +93424,9 @@ paths: schema: *220 examples: default: *663 - '301': *472 + '301': *468 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93749,8 +93443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -93777,13 +93471,13 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93801,8 +93495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -93835,16 +93529,16 @@ paths: description: Response content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Response content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -93866,10 +93560,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *664 - - *460 + - *659 responses: '204': description: Response @@ -93898,8 +93592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -93957,8 +93651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -93975,7 +93669,7 @@ paths: headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94003,8 +93697,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -94041,7 +93735,7 @@ paths: schema: type: string '403': *29 - '410': *657 + '410': *655 '422': *15 '404': *6 x-github: @@ -94061,8 +93755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 requestBody: required: true @@ -94118,8 +93812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *466 - - *467 + - *462 + - *463 - *664 - *17 - *19 @@ -94665,7 +94359,7 @@ paths: type: string comments: type: array - items: *580 + items: *576 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -94954,7 +94648,7 @@ paths: headers: Link: *47 '404': *6 - '410': *657 + '410': *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94971,8 +94665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -95048,8 +94742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95121,8 +94815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 - &683 name: key_id description: The unique identifier of the key. @@ -95155,8 +94849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *466 - - *467 + - *462 + - *463 - *683 responses: '204': @@ -95177,8 +94871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -95211,8 +94905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95282,8 +94976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95313,8 +95007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95379,8 +95073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *466 - - *467 + - *462 + - *463 - name: name in: path required: true @@ -95406,8 +95100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -95443,8 +95137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '202': *39 '403': @@ -95472,8 +95166,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -95499,9 +95193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *466 - - *467 - - *553 + - *462 + - *463 + - *549 responses: '200': description: Response @@ -95646,8 +95340,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95712,8 +95406,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95747,7 +95441,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *581 + schema: *579 examples: default: *685 '204': @@ -95774,8 +95468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *466 - - *467 + - *462 + - *463 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -95877,8 +95571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -95979,8 +95673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - &688 name: milestone_number description: The number that identifies the milestone. @@ -96012,8 +95706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 requestBody: required: false @@ -96070,8 +95764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 responses: '204': @@ -96093,8 +95787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *466 - - *467 + - *462 + - *463 - *688 - *17 - *19 @@ -96126,8 +95820,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *466 - - *467 + - *462 + - *463 - *689 - *690 - *227 @@ -96167,8 +95861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -96226,8 +95920,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -96399,8 +96093,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96479,8 +96173,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96587,8 +96281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -96614,8 +96308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -96719,8 +96413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *466 - - *467 + - *462 + - *463 responses: '201': description: Response @@ -96765,8 +96459,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -96822,8 +96516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *466 - - *467 + - *462 + - *463 - name: build_id in: path required: true @@ -96856,8 +96550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -96962,8 +96656,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - &697 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -97022,8 +96716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *466 - - *467 + - *462 + - *463 - *697 responses: '204': *154 @@ -97051,8 +96745,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -97310,8 +97004,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Private vulnerability reporting status @@ -97348,8 +97042,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: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '422': *14 @@ -97370,8 +97064,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: - - *466 - - *467 + - *462 + - *463 responses: '204': *154 '422': *14 @@ -97393,8 +97087,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -97426,8 +97120,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -97481,8 +97175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *466 - - *467 + - *462 + - *463 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -97542,7 +97236,7 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: default: *700 headers: @@ -97576,8 +97270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -98475,8 +98169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *466 - - *467 + - *462 + - *463 - name: sort in: query required: false @@ -98584,8 +98278,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *236 responses: '200': @@ -98669,8 +98363,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: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -98711,8 +98405,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: - - *466 - - *467 + - *462 + - *463 - *236 responses: '204': @@ -98734,8 +98428,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: - - *466 - - *467 + - *462 + - *463 - *236 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -98762,9 +98456,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -98785,8 +98479,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: - - *466 - - *467 + - *462 + - *463 - *236 requestBody: required: true @@ -98819,16 +98513,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -98850,10 +98544,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *236 - - *460 + - *659 responses: '204': description: Response @@ -98896,8 +98590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - &706 name: pull_number description: The number that identifies the pull request. @@ -98948,8 +98642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99016,8 +98710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -99080,7 +98774,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -99088,7 +98782,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -99118,8 +98812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *244 - name: direction @@ -99176,8 +98870,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -99371,8 +99065,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *236 requestBody: @@ -99482,8 +99176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -99494,7 +99188,7 @@ paths: application/json: schema: type: array - items: *581 + items: *579 examples: default: *708 headers: @@ -99526,8 +99220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -99538,7 +99232,7 @@ paths: application/json: schema: type: array - items: *594 + items: *592 examples: default: value: @@ -99576,8 +99270,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 responses: '204': @@ -99601,8 +99295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99714,8 +99408,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 responses: '200': @@ -99791,8 +99485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -99830,7 +99524,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -100366,8 +100060,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: true @@ -100402,7 +100096,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -100907,8 +100601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *17 - *19 @@ -101070,8 +100764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -101223,8 +100917,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - &710 name: review_id @@ -101299,8 +100993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101387,8 +101081,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *706 - *710 responses: @@ -101425,8 +101119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 - *17 @@ -101663,8 +101357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101757,8 +101451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *466 - - *467 + - *462 + - *463 - *706 - *710 requestBody: @@ -101819,8 +101513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *466 - - *467 + - *462 + - *463 - *706 requestBody: required: false @@ -101884,8 +101578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *466 - - *467 + - *462 + - *463 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -101942,8 +101636,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: - - *466 - - *467 + - *462 + - *463 - name: dir description: The alternate path to look for a README file in: path @@ -101987,8 +101681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -102092,8 +101786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -102276,8 +101970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - &717 name: asset_id description: The unique identifier of the asset. @@ -102327,7 +102021,7 @@ paths: type: User site_admin: false '404': *6 - '302': *596 + '302': *594 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102343,8 +102037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - *717 requestBody: required: false @@ -102391,8 +102085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *466 - - *467 + - *462 + - *463 - *717 responses: '204': @@ -102417,8 +102111,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -102503,8 +102197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -102529,8 +102223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *466 - - *467 + - *462 + - *463 - name: tag description: tag parameter in: path @@ -102567,8 +102261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *466 - - *467 + - *462 + - *463 - &720 name: release_id description: The unique identifier of the release. @@ -102603,8 +102297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 requestBody: required: false @@ -102692,8 +102386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 responses: '204': @@ -102714,8 +102408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *466 - - *467 + - *462 + - *463 - *720 - *17 - *19 @@ -102808,8 +102502,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *720 - name: name in: query @@ -102891,8 +102585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -102917,9 +102611,9 @@ paths: application/json: schema: type: array - items: *457 + items: *577 examples: - default: *459 + default: *658 headers: Link: *47 '404': *6 @@ -102940,8 +102634,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *466 - - *467 + - *462 + - *463 - *720 requestBody: required: true @@ -102972,16 +102666,16 @@ paths: description: Reaction exists content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '201': description: Reaction created content: application/json: - schema: *457 + schema: *577 examples: - default: *458 + default: *578 '422': *15 x-github: githubCloudOnly: false @@ -103003,10 +102697,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *466 - - *467 + - *462 + - *463 - *720 - - *460 + - *659 responses: '204': description: Response @@ -103030,9 +102724,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *466 - - *467 - - *519 + - *462 + - *463 + - *515 - *17 - *19 responses: @@ -103169,8 +102863,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - name: includes_parents @@ -103236,8 +102930,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 requestBody: description: Request body required: true @@ -103346,8 +103040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *466 - - *467 + - *462 + - *463 - *725 - *105 - *726 @@ -103382,8 +103076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *466 - - *467 + - *462 + - *463 - *730 responses: '200': @@ -103420,8 +103114,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103461,8 +103155,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103544,8 +103238,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103568,8 +103262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 - name: ruleset_id @@ -103606,8 +103300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *466 - - *467 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103680,8 +103374,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: - - *466 - - *467 + - *462 + - *463 - *427 - *428 - *429 @@ -103968,9 +103662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *435 responses: '200': @@ -104031,9 +103725,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 requestBody: required: true content: @@ -104171,9 +103865,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: - - *466 - - *467 - - *547 + - *462 + - *463 + - *543 - *19 - *17 responses: @@ -104308,8 +104002,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -104387,8 +104081,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: - - *466 - - *467 + - *462 + - *463 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -104507,8 +104201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *466 - - *467 + - *462 + - *463 - *110 - name: sort description: The property to sort the results by. @@ -104577,8 +104271,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -104973,8 +104667,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -105225,8 +104919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *466 - - *467 + - *462 + - *463 - *758 responses: '200': @@ -105259,8 +104953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *466 - - *467 + - *462 + - *463 - *758 requestBody: required: true @@ -105461,8 +105155,8 @@ 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: - - *466 - - *467 + - *462 + - *463 - *758 responses: '202': *39 @@ -105490,17 +105184,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: - - *466 - - *467 + - *462 + - *463 - *758 responses: '202': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 '400': *14 '422': *15 '403': *29 @@ -105526,8 +105220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -105626,8 +105320,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -105669,8 +105363,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -105746,8 +105440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -105843,8 +105537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -105998,8 +105692,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106042,8 +105736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *466 - - *467 + - *462 + - *463 - name: sha in: path required: true @@ -106151,8 +105845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106184,8 +105878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: if you subscribe to the repository @@ -106259,8 +105953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -106313,8 +106007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -106334,8 +106028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106414,8 +106108,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: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -106475,8 +106169,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: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -106530,8 +106224,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: - - *466 - - *467 + - *462 + - *463 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -106568,8 +106262,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *466 - - *467 + - *462 + - *463 - name: ref in: path required: true @@ -106605,8 +106299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *466 - - *467 + - *462 + - *463 - *17 - *19 responses: @@ -106638,8 +106332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *466 - - *467 + - *462 + - *463 - *19 - *17 responses: @@ -106682,8 +106376,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -106737,8 +106431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *466 - - *467 + - *462 + - *463 - &766 name: per description: The time frame to display results for. @@ -106856,8 +106550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -106948,8 +106642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *466 - - *467 + - *462 + - *463 responses: '200': description: Response @@ -107010,8 +106704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *466 - - *467 + - *462 + - *463 - *766 responses: '200': @@ -107109,8 +106803,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *466 - - *467 + - *462 + - *463 requestBody: required: true content: @@ -107384,8 +107078,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -107408,8 +107102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -107431,8 +107125,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -107458,8 +107152,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *466 - - *467 + - *462 + - *463 - name: ref in: path required: true @@ -107551,9 +107245,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -110025,7 +109719,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true comment_count: type: integer @@ -110045,7 +109739,7 @@ paths: url: type: string format: uri - verification: *643 + verification: *641 required: - author - committer @@ -110064,7 +109758,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *517 + properties: *513 nullable: true parents: type: array @@ -112266,246 +111960,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - *799 - - *453 - - *456 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - *799 - - *453 - - *456 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - *799 - - *453 - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *457 - examples: - default: *459 - headers: - Link: *47 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - *799 - - *453 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: *457 - examples: - default: *458 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -112731,7 +112185,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-user-is-a-team-maintainer: *804 '404': *6 @@ -112792,7 +112246,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *461 examples: response-if-users-membership-with-team-is-now-pending: *805 '403': @@ -112899,8 +112353,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 responses: '200': description: Alternative response with extra repository information @@ -113058,8 +112512,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 requestBody: required: false content: @@ -113110,8 +112564,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *799 - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -113146,9 +112600,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 '403': *29 '404': *6 x-github: @@ -113232,7 +112686,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *464 examples: default: value: @@ -114010,7 +113464,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -114018,7 +113472,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -114102,7 +113556,7 @@ paths: - visibility - selected_repositories_url examples: - default: *573 + default: *569 headers: Link: *47 x-github: @@ -114476,7 +113930,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '304': *37 '500': *40 '401': *25 @@ -114534,7 +113988,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '401': *25 '403': *29 '404': *6 @@ -114797,13 +114251,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *471 + repository: *467 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *571 - required: *572 + properties: *567 + required: *568 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -115585,7 +115039,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '304': *37 '500': *40 '400': *14 @@ -115625,7 +115079,7 @@ paths: application/json: schema: *376 examples: - default: *570 + default: *566 '500': *40 '401': *25 '403': *29 @@ -116773,7 +116227,7 @@ paths: required: true content: application/json: - schema: *654 + schema: *652 examples: default: value: @@ -119202,9 +118656,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *473 + default: *469 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -119242,7 +118696,7 @@ paths: application/json: schema: type: array - items: *656 + items: *654 examples: default: *829 headers: @@ -119856,8 +119310,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response if this repository is starred by you @@ -119885,8 +119339,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -119910,8 +119364,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: - - *466 - - *467 + - *462 + - *463 responses: '204': description: Response @@ -120591,7 +120045,7 @@ paths: initiator: type: string examples: - default: *513 + default: *509 '201': description: Response content: @@ -121122,7 +120576,7 @@ paths: application/json: schema: *22 examples: - default: *653 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -128802,7 +128256,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129125,7 +128579,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129455,7 +128909,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129797,7 +129251,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -130067,7 +129521,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130348,7 +129802,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130659,7 +130113,7 @@ x-webhooks: required: - login - id - dismissed_comment: *542 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -131758,7 +131212,7 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -131846,7 +131300,7 @@ x-webhooks: type: string enum: - auto_reopened - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -131934,7 +131388,7 @@ x-webhooks: type: string enum: - created - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132020,7 +131474,7 @@ x-webhooks: type: string enum: - dismissed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132106,7 +131560,7 @@ x-webhooks: type: string enum: - fixed - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132193,7 +131647,7 @@ x-webhooks: type: string enum: - reintroduced - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -132279,7 +131733,7 @@ x-webhooks: type: string enum: - reopened - alert: *602 + alert: *600 installation: *860 organization: *861 enterprise: *859 @@ -133772,7 +133226,7 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *608 + deployment: *606 pull_requests: type: array items: *704 @@ -237205,7 +236659,7 @@ x-webhooks: enterprise: *859 installation: *860 organization: *861 - repository: *471 + repository: *467 sender: *4 required: - changes @@ -242428,7 +241882,7 @@ x-webhooks: type: string required: - conclusion - deployment: *608 + deployment: *606 required: - action - repository @@ -242770,7 +242224,7 @@ x-webhooks: required: - status - steps - deployment: *608 + deployment: *606 required: - action - repository @@ -242987,7 +242441,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *608 + deployment: *606 required: - action - repository @@ -243205,7 +242659,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *608 + deployment: *606 required: - action - repository diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index b5019f3e7..f0e9148a3 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -41179,449 +41179,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" - }, - "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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", @@ -81297,338 +80854,6 @@ "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", @@ -142481,51 +141706,6 @@ "url" ] }, - "reaction": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -148083,6 +147263,51 @@ "updated_at" ] }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -315095,177 +314320,24 @@ "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 - } - } - ] - }, - "team-discussion": { - "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 - } - } - }, - "team-discussion-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": "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 - } - } - }, - "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", + "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, - "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, @@ -315279,7 +314351,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -315301,19 +314373,24 @@ "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", + "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, - "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, @@ -315326,7 +314403,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -315348,19 +314425,24 @@ "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", + "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", - "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, @@ -315373,12 +314455,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -315398,16 +314478,35 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] }, - "reaction": { + "team-discussion-comment": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -315427,8 +314526,76 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": { @@ -320810,6 +319977,64 @@ "updated_at": "2011-04-14T16:00:49Z" } }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, "commit-items": { "value": [ { @@ -337280,15 +336505,6 @@ "type": "integer" } }, - "reaction-id": { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -337608,6 +336824,15 @@ "$ref": "#/components/schemas/alert-number" } }, + "reaction-id": { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "commit-sha": { "name": "commit_sha", "description": "The SHA of the commit.", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 9e3dc3bb9..959d8f298 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -29715,326 +29715,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion - 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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/external-groups": get: summary: List a connection between an external group and a team @@ -58847,256 +58527,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -104347,43 +103777,6 @@ components: - number - updated_at - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -108716,6 +108109,43 @@ components: - author_association - created_at - updated_at + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -236227,56 +235657,6 @@ components: hooray: 0 eyes: 1 rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -240903,6 +240283,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -255095,13 +254525,6 @@ components: required: true schema: type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -255376,6 +254799,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index b5019f3e7..f0e9148a3 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -41179,449 +41179,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" - }, - "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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/reaction-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", @@ -81297,338 +80854,6 @@ "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "$ref": "#/components/parameters/comment-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/reaction" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/discussion-number" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/reaction" - }, - "examples": { - "default": { - "$ref": "#/components/examples/reaction" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" - }, - "deprecated": true - } - }, "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", @@ -142481,51 +141706,6 @@ "url" ] }, - "reaction": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -148083,6 +147263,51 @@ "updated_at" ] }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -315095,177 +314320,24 @@ "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 - } - } - ] - }, - "team-discussion": { - "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 - } - } - }, - "team-discussion-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": "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 - } - } - }, - "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", + "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, - "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, @@ -315279,7 +314351,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -315301,19 +314373,24 @@ "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", + "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, - "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, @@ -315326,7 +314403,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -315348,19 +314425,24 @@ "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", + "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", - "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, @@ -315373,12 +314455,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -315398,16 +314478,35 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] }, - "reaction": { + "team-discussion-comment": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -315427,8 +314526,76 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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": { @@ -320810,6 +319977,64 @@ "updated_at": "2011-04-14T16:00:49Z" } }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, "commit-items": { "value": [ { @@ -337280,15 +336505,6 @@ "type": "integer" } }, - "reaction-id": { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -337608,6 +336824,15 @@ "$ref": "#/components/schemas/alert-number" } }, + "reaction-id": { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "commit-sha": { "name": "commit_sha", "description": "The SHA of the commit.", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 9e3dc3bb9..959d8f298 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -29715,326 +29715,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!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/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!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/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion - 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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/external-groups": get: summary: List a connection between an external group and a team @@ -58847,256 +58527,6 @@ paths: category: teams subcategory: discussion-comments deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-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: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (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 reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -104347,43 +103777,6 @@ components: - number - updated_at - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -108716,6 +108109,43 @@ components: - author_association - created_at - updated_at + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -236227,56 +235657,6 @@ components: hooray: 0 eyes: 1 rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -240903,6 +240283,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -255095,13 +254525,6 @@ components: required: true schema: type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -255376,6 +254799,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 5920663dc..e6537df05 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -185398,17 +185398,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\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/reactions`.\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": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-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/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -185428,61 +185428,6 @@ "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" - } - }, - { - "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 team discussion comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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": { @@ -185491,236 +185436,92 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "example": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ], + "type": "array", + "items": { "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], "properties": { - "name": { - "nullable": true, - "type": "string" + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "email": { - "nullable": true, + "group_name": { + "description": "The display name of the group", + "example": "group-azuread-test", "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "updated_at": { + "description": "The time of the last update for this group", + "example": "2019-06-03 22:27:15:000 -700", + "type": "string" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "teams", + "subcategory": "external-groups" } }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\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/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "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/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -185740,24 +185541,6 @@ "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": { @@ -185767,29 +185550,20 @@ "schema": { "type": "object", "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "group_id": { + "type": "integer", + "description": "External Group Id", + "example": 1 } }, "required": [ - "content" + "group_id" ] }, "examples": { "default": { "value": { - "content": "heart" + "group_id": 123 } } } @@ -185798,407 +185572,149 @@ }, "responses": { "200": { - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], "properties": { - "id": { - "type": "integer", - "example": 1 + "group_id": { + "description": "The internal ID of the group", + "example": 1, + "type": "integer" }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "group_name": { + "description": "The display name for the group", + "example": "group-azuread-test", + "type": "string" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "updated_at": { + "description": "The date when the group was last updated_at", + "example": "2021-01-03 22:27:15:000 -700", + "type": "string" + }, + "teams": { + "description": "An array of teams linked to this group", + "example": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "example": 1, + "type": "integer" + }, + "team_name": { + "description": "The name of the team", + "example": "team-test", + "type": "string" + } + } + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "members": { + "description": "An array of external members linked to this group", + "example": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ], + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "example": 1, + "type": "integer" + }, + "member_login": { + "description": "The handle/login for the user", + "example": "mona-lisa_eocsaxrs", + "type": "string" + }, + "member_name": { + "description": "The user display name/profile name", + "example": "Mona Lisa", + "type": "string" + }, + "member_email": { + "description": "An email attached to a user", + "example": "mona_lisa@github.com", + "type": "string" + } + } + } } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "team_id": 2, + "team_name": "team-test2" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "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" + } ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" } } } @@ -186207,24 +185723,22 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + }, "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "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/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -186244,33 +185758,6 @@ "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" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -186279,24 +185766,24 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/members": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members" }, "parameters": [ { @@ -186318,31 +185805,18 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 team discussion.", + "name": "role", + "description": "Filters members returned by their role in the team.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "member", + "maintainer", + "all" + ], + "default": "all" } }, { @@ -186372,76 +185846,622 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "example": "MDQ6VXNlcjE=" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/projects": { + "get": { + "summary": "List team projects", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/list-projects-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", @@ -186506,36 +186526,57 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" ] }, "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "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", - "user", - "content", - "created_at" + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" ] } }, @@ -186543,9 +186584,17 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "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=", @@ -186565,8 +186614,15 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -186586,20 +186642,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\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/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "teams/check-permissions-for-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project" }, "parameters": [ { @@ -186621,8 +186682,8 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { @@ -186630,61 +186691,48 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "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", - "example": 1 + "type": "integer" }, "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "nullable": true }, - "user": { + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -186806,44 +186854,73 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" ] }, "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "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", - "user", - "content", - "created_at" + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "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=", @@ -186863,212 +186940,129 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } } } }, - "201": { - "description": "Response", + "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", + "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" + ] + } + }, + "nullable": true + }, + "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": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + "message": { + "type": "string" }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" + "documentation_url": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + } }, "examples": { - "default": { + "response-if-the-project-is-not-owned-by-the-organization": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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" } } } @@ -187078,23 +187072,24 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\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": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/remove-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team" }, "parameters": [ { @@ -187116,17 +187111,8 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { @@ -187142,397 +187128,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/external-groups": { - "get": { - "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "example": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ], - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name of the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The time of the last update for this group", - "example": "2019-06-03 22:27:15:000 -700", - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" - } - }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/link-external-idp-group-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "example": 1 - } - }, - "required": [ - "group_id" - ] - }, - "examples": { - "default": { - "value": { - "group_id": 123 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "example": 1, - "type": "integer" - }, - "group_name": { - "description": "The display name for the group", - "example": "group-azuread-test", - "type": "string" - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "example": "2021-01-03 22:27:15:000 -700", - "type": "string" - }, - "teams": { - "description": "An array of teams linked to this group", - "example": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "example": 1, - "type": "integer" - }, - "team_name": { - "description": "The name of the team", - "example": "team-test", - "type": "string" - } - } - } - }, - "members": { - "description": "An array of external members linked to this group", - "example": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ], - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "example": 1, - "type": "integer" - }, - "member_login": { - "description": "The handle/login for the user", - "example": "mona-lisa_eocsaxrs", - "type": "string" - }, - "member_name": { - "description": "The user display name/profile name", - "example": "Mona Lisa", - "type": "string" - }, - "member_email": { - "description": "An email attached to a user", - "example": "mona_lisa@github.com", - "type": "string" - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" - } + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/members": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-members-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -187553,21 +187167,6 @@ "type": "string" } }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", @@ -187595,737 +187194,642 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { "type": "integer", "format": "int64", - "example": 1 + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "followers_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "following_url": { + "downloads_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "gists_url": { + "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "starred_url": { + "forks_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "subscriptions_url": { + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "repos_url": { + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "events_url": { + "statuses_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "type": { + "subscription_url": { "type": "string", - "example": "User" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, - "starred_at": { + "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", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "user_view_type": { + "created_at": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - } - } - } - } - }, - "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role that this user should have in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if team synchronization is set up" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/projects": { - "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "columns_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true }, - "id": { - "type": "integer" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } }, - "node_id": { - "type": "string" + "role_name": { + "type": "string", + "example": "admin" }, - "name": { + "temp_clone_token": { "type": "string" }, - "body": { - "type": "string", - "nullable": true + "delete_branch_on_merge": { + "type": "boolean" }, - "number": { + "subscribers_count": { "type": "integer" }, - "state": { - "type": "string" + "network_count": { + "type": "integer" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "key": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "contributor_covenant" }, - "gravatar_id": { + "name": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "events_url": { + "body": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, - "received_events_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "type": { - "type": "string", - "example": "User" + "name": { + "type": "string" }, - "site_admin": { - "type": "boolean" + "spdx_id": { + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "url": { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "public" + "node_id": { + "type": "string" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "nullable": true }, - "created_at": { - "type": "string" + "forks": { + "type": "integer", + "example": 0 }, - "updated_at": { - "type": "string" + "open_issues": { + "type": "integer", + "example": 0 }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" + "watchers": { + "type": "integer", + "example": 0 }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "allow_forking": { "type": "boolean" }, - "permissions": { + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, "type": "object", "properties": { - "read": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "write": { - "type": "boolean" + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "admin": { - "type": "boolean" + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } - }, - "required": [ - "read", - "write", - "admin" - ] + } } }, "required": [ - "owner_url", - "url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -188333,17 +187837,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=", @@ -188363,14 +187861,94 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } } } ] @@ -188392,24 +187970,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "subcategory": "teams" + } } }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-project-in-org", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -188431,57 +188006,127 @@ } }, { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], "responses": { "200": { - "description": "Response", + "description": "Alternative response with repository permissions", "content": { "application/json": { "schema": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer" }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "body": { + "full_name": { "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], "nullable": true }, - "number": { + "forks": { "type": "integer" }, - "state": { - "type": "string" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "creator": { + "role_name": { + "type": "string", + "example": "admin" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -188603,73 +188248,463 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "created_at": { - "type": "string" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "updated_at": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "fork": { "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": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "example": false + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "examples": { + "alternative-response-with-repository-permissions": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -188689,45 +188724,135 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } + "admin": false, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } } } } } }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, "404": { - "description": "Not Found if project is not managed by this team" + "description": "Not Found if team does not have permission for the repository" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "subcategory": "teams" + } }, "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], - "operationId": "teams/add-or-update-project-permissions-in-org", + "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -188749,12 +188874,21 @@ } }, { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -188767,21 +188901,15 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } - }, - "nullable": true + } }, "examples": { "default": { - "summary": "Updates the permissions for the team to write for the project", + "summary": "Adding a team to an organization repository with the write role", "value": { - "permission": "write" + "permission": "push" } } } @@ -188791,54 +188919,25 @@ "responses": { "204": { "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "subcategory": "teams" + } }, "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], - "operationId": "teams/remove-project-in-org", + "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -188860,12 +188959,21 @@ } }, { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -188878,24 +188986,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "subcategory": "teams" + } } }, - "/orgs/{org}/teams/{team_slug}/repos": { + "/orgs/{org}/teams/{team_slug}/teams": { "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], - "operationId": "teams/list-repos-in-org", + "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -188937,768 +189042,252 @@ ], "responses": { "200": { - "description": "Response", + "description": "if child teams exist", "content": { "application/json": { "schema": { "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64", - "example": 1296269 + "type": "integer" }, "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "type": "string" }, "name": { - "type": "string", - "example": "Hello-World" + "type": "string" }, - "full_name": { + "slug": { + "type": "string" + }, + "description": { "type": "string", - "example": "octocat/Hello-World" + "nullable": true }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "pull": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "triage": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", + "url", + "members_url", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" ] } }, "examples": { - "default": { + "response-if-child-teams-exist": { "value": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - } - } + "html_url": "https://github.com/orgs/rails/teams/core" } ] } @@ -189723,17 +189312,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/check-permissions-for-repo-in-org", + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -189746,136 +189335,135 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "security_product", "in": "path", + "description": "The security feature to enable or disable.", "required": true, "schema": { - "type": "string" + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] } }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "enablement", "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", "required": true, "schema": { - "type": "string" + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } } + } + }, + "responses": { + "204": { + "description": "Action started" }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "summary": "Get a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card" + }, + "parameters": [ { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "card_id", + "description": "The unique identifier of the card.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "200": { - "description": "Alternative response with repository permissions", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/cards/1478" + }, "id": { - "description": "Unique identifier of the repository", + "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" }, - "full_name": { + "note": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], + "example": "Add payload for delete Project column", "nullable": true }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "owner": { + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -190000,460 +189588,451 @@ ], "nullable": true }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "format": "date-time", + "example": "2016-09-05T14:21:06Z" }, - "description": { + "updated_at": { "type": "string", - "example": "This your first repo!", - "nullable": true + "format": "date-time", + "example": "2016-09-05T14:20:22Z" }, - "fork": { + "archived": { + "description": "Whether or not the card is archived", + "example": false, "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "column_name": { + "type": "string" }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "project_id": { + "type": "string" }, - "contributors_url": { + "column_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/projects/columns/367" }, - "deployments_url": { + "content_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" }, - "downloads_url": { + "project_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/projects/120" + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "documentation_url": { + "type": "string" }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "url": { + "type": "string" }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "documentation_url": { + "type": "string" }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "url": { + "type": "string" }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "documentation_url": { + "type": "string" }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "url": { + "type": "string" }, - "issues_url": { + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an existing project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + } + } + }, + "examples": { + "default": { + "summary": "Change the note on the card", + "value": { + "note": "Add payload for delete Project column" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "format": "uri", + "example": "https://api.github.com/projects/columns/cards/1478" }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "id": { + "description": "The project card's ID", + "example": 42, + "type": "integer", + "format": "int64" }, - "labels_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { + "note": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", + "example": "Add payload for delete Project column", "nullable": true }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], "nullable": true }, - "language": { + "created_at": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 + "format": "date-time", + "example": "2016-09-05T14:21:06Z" }, - "default_branch": { - "description": "The default branch of the repository.", + "updated_at": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "format": "date-time", + "example": "2016-09-05T14:20:22Z" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, + "description": "Whether or not the card is archived", + "example": false, "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "column_name": { + "type": "string" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", + "project_id": { "type": "string" }, - "pushed_at": { + "column_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/projects/columns/367" }, - "created_at": { + "content_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" }, - "updated_at": { + "project_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "example": false - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/projects/120" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "note", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "column_url", + "project_url", + "creator", "created_at", "updated_at" ] }, "examples": { - "alternative-response-with-repository-permissions": { + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -190473,708 +190052,532 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" } } } } } }, - "204": { - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." - }, - "404": { - "description": "Not Found if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "304": { + "description": "Not modified" }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } - }, - "examples": { - "default": { - "summary": "Adding a team to an organization repository with the write role", - "value": { - "permission": "push" + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true }, "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "summary": "Delete a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "teams" + "projects-classic" ], - "operationId": "teams/remove-repo-in-org", + "operationId": "projects-classic/delete-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "card_id", + "description": "The unique identifier of the card.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } } } - ], - "responses": { - "204": { - "description": "Response" - } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "/projects/columns/cards/{card_id}/moves": { + "post": { + "summary": "Move a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "teams" + "projects-classic" ], - "operationId": "teams/list-child-in-org", + "operationId": "projects-classic/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "card_id", + "description": "The unique identifier of the card.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", + "example": "bottom", + "type": "string", + "pattern": "^(?:top|bottom|after:\\d+)$" + }, + "column_id": { + "description": "The unique identifier of the column the card should be moved to", + "example": 42, + "type": "integer" + } + }, + "required": [ + "position" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Move the card to the bottom of the column", + "value": { + "column_id": 42, + "position": "bottom" + } + } + } } - }, - { - "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 + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } } }, - { - "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 + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "field": { + "type": "string" + } + } + } + } + } + } + } } - } - ], - "responses": { - "200": { - "description": "if child teams exist", + }, + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "code": { + "type": "string" }, - "admin": { - "type": "boolean" + "message": { + "type": "string" } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + } + } + } + } + } + } + } + }, + "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": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "resource": { + "type": "string" }, - "slug": { - "type": "string", - "example": "justice-league" + "field": { + "type": "string" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", + "message": { "type": "string" }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] + "code": { + "type": "string" }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 + "index": { + "type": "integer" }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent", - "type" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" - }, - "html_url": "https://github.com/orgs/rails/teams/core" + } } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/{security_product}/{enablement}": { - "post": { - "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "The security feature to enable or disable.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "query_suite": { - "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", - "type": "string", - "enum": [ - "default", - "extended" - ] + } } } - }, - "examples": { - "default": { - "value": null - } } } } }, - "responses": { - "204": { - "description": "Action started" - }, - "422": { - "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" - } - }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "orgs", - "deprecationDate": "2024-07-22", - "removalDate": "2025-07-22" + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, "deprecated": true } }, - "/projects/columns/cards/{card_id}": { + "/projects/columns/{column_id}": { "get": { - "summary": "Get a project card", + "summary": "Get a project column", "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects-classic" ], - "operationId": "projects-classic/get-card", + "operationId": "projects-classic/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "name": "column_id", + "description": "The unique identifier of the column.", "in": "path", "required": true, "schema": { @@ -191188,200 +190591,57 @@ "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project Column", + "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "https://api.github.com/projects/columns/367" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" }, "id": { - "description": "The project card's ID", + "description": "The unique identifier of the project column", "example": 42, - "type": "integer", - "format": "int64" + "type": "integer" }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "example": "2016-09-05T14:18:44Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "2016-09-05T14:22:28Z" } }, "required": [ "id", "node_id", - "note", "url", - "column_url", "project_url", - "creator", + "cards_url", + "name", "created_at", "updated_at" ] @@ -191389,36 +190649,14 @@ "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } @@ -191454,8 +190692,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -191480,8 +190718,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -191508,30 +190746,30 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "cards", + "subcategory": "columns", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true }, "patch": { - "summary": "Update an existing project card", + "summary": "Update an existing project column", "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ "projects-classic" ], - "operationId": "projects-classic/update-card", + "operationId": "projects-classic/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "name": "column_id", + "description": "The unique identifier of the column.", "in": "path", "required": true, "schema": { @@ -191540,30 +190778,27 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "type": "object", "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" } - } + }, + "required": [ + "name" + ], + "type": "object" }, "examples": { "default": { - "summary": "Change the note on the card", + "summary": "Rename the project column", "value": { - "note": "Add payload for delete Project column" + "name": "To Do" } } } @@ -191576,200 +190811,57 @@ "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project Column", + "description": "Project columns contain cards of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "https://api.github.com/projects/columns/367" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" }, "id": { - "description": "The project card's ID", + "description": "The unique identifier of the project column", "example": 42, - "type": "integer", - "format": "int64" + "type": "integer" }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "example": "2016-09-05T14:18:44Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "2016-09-05T14:22:28Z" } }, "required": [ "id", "node_id", - "note", "url", - "column_url", "project_url", - "creator", + "cards_url", + "name", "created_at", "updated_at" ] @@ -191777,36 +190869,14 @@ "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } @@ -191867,9 +190937,49 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/delete-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -191894,872 +191004,13 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { @@ -469046,2831 +467297,175 @@ } } } - ], - "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", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", - "tags": [ - "teams" - ], - "operationId": "teams/update-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team.", - "nullable": true - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - }, - "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "example": "notifications_enabled" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ], - "nullable": true - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "example": 37 - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "example": 42 - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "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.", - "tags": [ - "teams" - ], - "operationId": "teams/list-discussions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" + "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" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/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" }, - "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" - ] + { + "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" } - }, - "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" ] } + } + } + } + }, + "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": [ { - "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==" + } } } } @@ -471878,406 +467473,761 @@ }, "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": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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" } } } @@ -472286,28 +468236,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": [ { @@ -472318,763 +468265,1315 @@ "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", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 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": { - "title": "Simple User", - "description": "A GitHub user.", + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "Justice League" }, - "following_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "nullable": true, + "example": "A great team." }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "admin" }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "closed" }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "notifications_enabled" }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://github.com/orgs/rails/teams/core" }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "events_url": { + "slug": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "justice-league" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" }, "type": { + "description": "The ownership type of the team", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 }, - "user_view_type": { - "type": "string", - "example": "public" + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ], "nullable": true }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { + "members_count": { "type": "integer", - "example": 0 + "example": 3 }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -473083,20 +469582,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": [ { @@ -473107,20 +469606,106 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -473129,22 +469714,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": [ { @@ -473156,15 +469741,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.", @@ -473206,8 +469782,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": { @@ -473336,57 +469912,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -473443,12 +470043,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -473478,19 +470083,24 @@ "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", + "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, - "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, @@ -473523,20 +470133,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": [ { @@ -473547,15 +470157,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -473565,19 +470166,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." } } } @@ -473590,8 +470202,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": { @@ -473720,57 +470332,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -473827,12 +470463,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -473860,19 +470501,24 @@ "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", + "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, - "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, @@ -473897,22 +470543,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": [ { @@ -473932,15 +470578,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -473949,8 +470586,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": { @@ -474079,57 +470716,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -474186,12 +470847,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -474219,19 +470885,24 @@ "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", + "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, - "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, @@ -474255,20 +470926,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": [ { @@ -474288,37 +470959,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" } } } @@ -474331,8 +470994,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": { @@ -474461,57 +471124,81 @@ "nullable": true }, "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", "type": "string" }, "body_html": { "type": "string", - "example": "

Do you like apples?

" + "example": "

Hi! This is an area for us to collaborate as a team

" }, "body_version": { "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "last_edited_at": { "type": "string", "format": "date-time", "nullable": true }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" }, "node_id": { "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "example": 42, "type": "integer" }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" + "example": "2018-01-25T18:56:31Z" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" }, "reactions": { "title": "Reaction Rollup", @@ -474568,12 +471255,17 @@ "body", "body_html", "body_version", + "comments_count", + "comments_url", "created_at", "last_edited_at", - "discussion_url", "html_url", + "pinned", + "private", "node_id", "number", + "team_url", + "title", "updated_at", "url" ] @@ -474601,19 +471293,24 @@ "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", + "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", - "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, @@ -474637,20 +471334,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": [ { @@ -474670,15 +471367,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -474692,22 +471380,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}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-legacy", + "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -474729,31 +471417,17 @@ } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 team discussion comment.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -474783,19 +471457,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -474920,33 +471586,122 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] } }, @@ -474954,9 +471709,7 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -474976,8 +471729,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } ] } @@ -474997,23 +471771,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -475033,15 +471807,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -475051,29 +471816,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like apples?" } } } @@ -475086,19 +471841,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -475223,41 +471970,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -475277,8 +472111,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 + } } } } @@ -475287,27 +472142,28 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true } }, - "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List reactions for a team 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 [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-legacy", + "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -475329,40 +472185,12 @@ } }, { - "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 team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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", + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -475372,239 +472200,326 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "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": [ - { + "value": { + "author": { + "login": "octocat", "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": "reactions" + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" }, "deprecated": true }, - "post": { - "summary": "Create reaction for a team 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 reaction for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-legacy", + "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -475624,6 +472539,15 @@ "schema": { "type": "integer" } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -475633,29 +472557,19 @@ "schema": { "type": "object", "properties": { - "content": { + "body": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion comment's body text." } }, "required": [ - "content" + "body" ] }, "examples": { "default": { "value": { - "content": "heart" + "body": "Do you like pineapples?" } } } @@ -475663,24 +472577,16 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -475805,41 +472711,128 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", "node_id", - "user", - "content", - "created_at" + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -475859,8 +472852,29 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "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, + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}