diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 4d46245e7..07dfe5dfc 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -29725,449 +29725,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", @@ -66584,338 +66141,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)", @@ -123173,66 +122398,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -129575,6 +128740,66 @@ "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -300153,177 +299378,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, @@ -300337,7 +299409,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -300359,19 +299431,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, @@ -300384,7 +299461,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -300406,19 +299483,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, @@ -300431,12 +299513,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -300456,16 +299536,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=", @@ -300485,8 +299584,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": { @@ -305755,6 +304922,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": [ { @@ -321473,15 +320698,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", @@ -321801,6 +321017,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 34e459019..687d85d34 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -21469,326 +21469,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 @@ -48289,256 +47969,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) @@ -89384,49 +88814,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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -94037,6 +93424,49 @@ 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -222245,56 +221675,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: @@ -226839,6 +226219,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 @@ -240439,13 +239869,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 @@ -240720,6 +240143,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 4d46245e7..07dfe5dfc 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -29725,449 +29725,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", @@ -66584,338 +66141,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)", @@ -123173,66 +122398,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -129575,6 +128740,66 @@ "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -300153,177 +299378,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, @@ -300337,7 +299409,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -300359,19 +299431,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, @@ -300384,7 +299461,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -300406,19 +299483,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, @@ -300431,12 +299513,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -300456,16 +299536,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=", @@ -300485,8 +299584,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": { @@ -305755,6 +304922,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": [ { @@ -321473,15 +320698,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", @@ -321801,6 +321017,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 34e459019..687d85d34 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -21469,326 +21469,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 @@ -48289,256 +47969,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) @@ -89384,49 +88814,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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -94037,6 +93424,49 @@ 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -222245,56 +221675,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: @@ -226839,6 +226219,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 @@ -240439,13 +239869,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 @@ -240720,6 +240143,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 11a00aeb0..22acab592 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -232253,17 +232253,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": [ { @@ -232285,40 +232285,376 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "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": "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": "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" } }, { @@ -232348,12 +232684,31 @@ "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -232361,215 +232716,139 @@ "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDQ6VXNlcjE=" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "gravatar_id": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "41d064eb2195891e12d0413f63227ea7" ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "user", - "content", - "created_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } }, @@ -232577,30 +232856,24 @@ "default": { "value": [ { + "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 } ] } @@ -232620,20 +232893,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}/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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/get-membership-for-user-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#get-team-membership-for-a-user" }, "parameters": [ { @@ -232655,54 +232930,143 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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": "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": { - "content": { + "role": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The role that this user should have in the team.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "member", + "maintainer" + ], + "default": "member" } - }, - "required": [ - "content" - ] + } }, "examples": { "default": { + "summary": "Add or update team membership for an organization member", "value": { - "content": "heart" + "role": "maintainer" } } } @@ -232711,549 +233075,82 @@ }, "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": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] + "url": { + "type": "string", + "format": "uri" }, - "node_id": { + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "member" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", + "state": { + "description": "The state of the user's membership in the team.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "active", + "pending" ] } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "role", + "state", + "url" ] }, "examples": { - "default": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", "value": { - "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": "member", + "state": "pending" } } } } } }, - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - } - } - } - } + "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": "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.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/remove-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#remove-team-membership-for-a-user" }, "parameters": [ { @@ -233275,57 +233172,42 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": [ { @@ -233346,34 +233228,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).\"", @@ -233401,381 +233255,1187 @@ "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", + "format": "int64", "examples": [ - 1 + 1296269 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/repos/octocat/Hello-World" ] - } - }, - "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" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": 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": { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "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.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "owner": { "anyOf": [ { "type": "null" @@ -233950,307 +234610,606 @@ } ] }, - "content": { - "description": "The reaction to use", + "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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/repos/octocat/Hello-World" ] - } - }, - "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", + }, + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "content": { - "description": "The reaction to use", + "branches_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" ], + "format": "uri", "examples": [ - "heart" + "git:git.example.com/octocat/Hello-World" ] }, - "created_at": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + 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", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + 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", - "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", + "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": { - "default": { + "alternative-response-with-repository-permissions": { "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=", @@ -234270,34 +235229,220 @@ "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, + "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": false, - "category": "reactions", - "subcategory": "reactions" + "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": [ { @@ -234319,21 +235464,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" } } ], @@ -234345,22 +235490,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": [ { @@ -234402,575 +235547,298 @@ ], "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", - "null" - ] + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": [ "string", "null" ] }, - "failed_reason": { - "type": [ - "string", - "null" - ] + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "type": "boolean" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/members": { - "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "tags": [ - "teams" - ], - "operationId": "teams/list-members-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "members_url": { + "type": "string" }, - "events_url": { + "repositories_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "type": { + "description": "The ownership type of the team", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "enterprise", + "organization" ] }, - "type": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "User" + 37 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 42 ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } ] } }, "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", + "parent", + "type" ] } }, "examples": { - "default": { + "response-if-child-teams-exist": { "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 + "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" } ] } @@ -234991,126 +235859,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "members" + "subcategory": "teams" } } }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - } - } - } - } - }, - "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "/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/add-or-update-membership-for-user-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#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -235123,21 +235886,34 @@ } }, { - "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": "username", - "description": "The handle for the GitHub user account.", + "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" + ] } } ], @@ -235146,1197 +235922,524 @@ "content": { "application/json": { "schema": { - "type": "object", "properties": { - "role": { + "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", - "description": "The role that this user should have in the team.", "enum": [ - "member", - "maintainer" - ], - "default": "member" + "default", + "extended" + ] } } }, "examples": { "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } + "value": null } } } } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" + "204": { + "description": "Action started" }, "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" + "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" - } - }, - "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" - } + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/repos": { + "/rate_limit": { "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 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/list-repos-in-org", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + "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": "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 - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "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" - ] - } + "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" } }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } - } - } - }, - "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" - ] - } + }, + "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": [ - { - "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 + "value": { + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 }, - "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 + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "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": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "type": "string" + "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" + } + } } } } @@ -236345,42 +236448,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "/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}`.", + "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/check-permissions-for-repo-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/rest/repos/repos#get-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.", @@ -236402,19 +236487,19 @@ ], "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": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", "type": "integer", + "format": "int64", "examples": [ - 42 + 1296269 ] }, "node_id": { @@ -236424,10 +236509,9 @@ ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Hello-World" ] }, "full_name": { @@ -236436,280 +236520,175 @@ "octocat/Hello-World" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "admin": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, - "pull": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "triage": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "push": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "maintain": { + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -237037,13 +237016,13 @@ ] }, "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", "examples": [ 108 ] }, "default_branch": { - "description": "The default branch of the repository.", "type": "string", "examples": [ "master" @@ -237056,8 +237035,6 @@ ] }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, "type": "boolean", "examples": [ true @@ -237067,27 +237044,27 @@ "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, "type": "boolean", "examples": [ true @@ -237097,16 +237074,18 @@ "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { "type": "boolean", "examples": [ true ] }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { @@ -237115,2134 +237094,58 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "type": "string", + "examples": [ + "public" + ] }, "pushed_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - 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, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "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/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", - "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" - ] - }, - "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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - 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", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { + "allow_rebase_merge": { "type": "boolean", "examples": [ true @@ -618053,1170 +615956,56 @@ "https://api.github.com/users/octocat/received_events" ] }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "fragment": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "draft": { - "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" + ] + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -619383,784 +616172,461 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { "type": "integer" }, - "watchers": { + "completed": { "type": "integer" }, - "master_branch": { - "type": "string" + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "blocking": { + "type": "integer" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "total_blocked_by": { + "type": "integer" }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "total_blocking": { + "type": "integer" } }, "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" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] }, - "body_html": { - "type": "string" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } }, - "body_text": { + "state": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "state_reason": { "type": [ - "object", + "string", "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } - }, - "required": [ - "id", - "node_id", - "name", - "description" ] }, - "performed_via_github_app": { + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 37 + 1002604 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "node_id": { + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "open" ] }, - "client_id": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "v1.0" ] }, - "owner": { - "oneOf": [ + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -620304,680 +616770,118 @@ "user_view_type": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 280, - "incomplete_results": false, - "items": [ - { - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", - "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", - "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", - "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", - "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", - "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", - "id": 35802, - "node_id": "MDU6SXNzdWUzNTgwMg==", - "number": 132, - "title": "Line Number Indexes Beyond 20 Not Displayed", - "user": { - "login": "Nick3C", - "id": 90254, - "node_id": "MDQ6VXNlcjkwMjU0", - "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/Nick3C", - "html_url": "https://github.com/Nick3C", - "followers_url": "https://api.github.com/users/Nick3C/followers", - "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", - "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", - "organizations_url": "https://api.github.com/users/Nick3C/orgs", - "repos_url": "https://api.github.com/users/Nick3C/repos", - "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", - "received_events_url": "https://api.github.com/users/Nick3C/received_events", - "type": "User", - "site_admin": true - }, - "labels": [ - { - "id": 4, - "node_id": "MDU6TGFiZWw0", - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", - "name": "bug", - "color": "ff0000" - } - ], - "state": "open", - "assignee": null, - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "comments": 15, - "created_at": "2009-07-12T20:10:41Z", - "updated_at": "2009-07-19T09:23:43Z", - "closed_at": null, - "pull_request": { - "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "body": "...", - "score": 1, - "locked": true, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ] - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/labels": { - "get": { - "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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 find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/labels", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-labels" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "query", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. 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": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ] - } - }, - { - "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": "Label Search Result Item", - "description": "Label Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" + "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" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "node_id": { - "type": "string" + "comments": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" + "format": "date-time" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "date-time" }, - "description": { + "closed_at": { "type": [ "string", "null" - ] - }, - "score": { - "type": "number" + ], + "format": "date-time" }, "text_matches": { "title": "Search Result Text Matches", @@ -621019,308 +616923,203 @@ } } } - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "incomplete_results": false, - "items": [ - { - "id": 418327088, - "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", - "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", - "name": "enhancement", - "color": "84b6eb", - "default": true, - "description": "New feature or request.", - "score": 1 - }, - { - "id": 418327086, - "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", - "url": "https://api.github.com/repos/octocat/linguist/labels/bug", - "name": "bug", - "color": "ee0701", - "default": true, - "description": "Something isn't working.", - "score": 1 - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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": [ - { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - { + "diff_url": { "type": [ - "integer", + "string", "null" - ] + ], + "format": "uri" }, - { + "html_url": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/repositories": { - "get": { - "summary": "Search repositories", - "description": "Find repositories 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 repositories, you can get text match metadata for the **name** and **description** fields 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 popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-repositories" - }, - "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 for repositories](https://docs.github.com/articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "stars", - "forks", - "help-wanted-issues", - "updated" - ] - } - }, - { - "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": "Repo Search Result Item", - "description": "Repo Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { + "body": { "type": "string" }, - "name": { - "type": "string" + "score": { + "type": "number" }, - "full_name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -621487,966 +617286,1223 @@ "type", "url" ] - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "score": { - "type": "number" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "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" - }, - "license": { - "anyOf": [ - { - "type": "null" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "maintain": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "push": { - "type": "boolean" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "triage": { - "type": "boolean" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 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", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "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", - "examples": [ - 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": [ - { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + 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", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - { + "created_at": { "type": [ - "integer", + "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - { + "updated_at": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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", - "null" - ] - }, - "short_description": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_by": { - "type": [ - "string", - "null" + }, + "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" ] }, - "released": { - "type": [ - "string", - "null" - ] + "body_html": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "body_text": { + "type": "string" }, - "updated_at": { + "timeline_url": { "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" + "format": "uri" }, - "repository_count": { + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "integer", + "object", "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { + "issues": { "type": "string" }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } - } - } - } - } - } - }, - "related": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "name": { + "additionalProperties": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } - } - } - } - } - }, - "aliases": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] } - } + ] + }, + "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": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", "updated_at", - "featured", - "curated", "score" ] } @@ -622456,436 +618512,103 @@ "examples": { "default": { "value": { - "total_count": 6, + "total_count": 280, "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "score": { - "type": "number" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, - "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", + "body": "...", "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 + "locked": true, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -622894,9 +618617,6 @@ } } }, - "304": { - "description": "Not modified" - }, "503": { "description": "Service unavailable", "content": { @@ -622992,6 +618712,35 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { @@ -623002,27 +618751,81 @@ } } }, - "/teams/{team_id}": { + "/search/labels": { "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.", + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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 find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/get-legacy", + "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/rest/search/search#search-labels" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", "required": true, "schema": { "type": "integer" } + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. 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": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + } + }, + { + "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": { @@ -623031,753 +618834,146 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "node_id": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "score": { + "type": "number" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + } } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -623803,1794 +618999,1821 @@ } } } - } - }, - "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", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] + "type": "string" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "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" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "documentation_url": { + "type": "string" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "field": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories 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 repositories, you can get text match metadata for the **name** and **description** fields 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 popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-repositories" + }, + "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 for repositories](https://docs.github.com/articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + } + }, + { + "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": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "pushed_at": { + "type": "string", + "format": "date-time" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "score": { + "type": "number" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "topics": { + "type": "array", + "items": { "type": "string" + } + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "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" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "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": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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", + "examples": [ + false + ] + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] + "required": [ + "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": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { + } + } + } + } + } + }, + "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" }, - "status": { + "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "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", + "null" + ] + }, + "short_description": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "created_by": { + "type": [ + "string", + "null" + ] + }, + "released": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + "logo_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "related": { + "type": [ + "array", + "null" + ], + "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", + "null" + ], + "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": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "incomplete_results", + "items" ], "properties": { - "message": { - "type": "string" + "total_count": { + "type": "integer" }, - "documentation_url": { - "type": "string" + "incomplete_results": { + "type": "boolean" }, - "errors": { + "items": { "type": "array", "items": { + "title": "User Search Result Item", + "description": "User Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "login": { "type": "string" }, - "field": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string" }, - "message": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, - "code": { + "score": { + "type": "number" + }, + "following_url": { "type": "string" }, - "index": { + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "public_repos": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "site_admin": { + "type": "boolean" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } + } + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -625677,25 +620900,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true + "category": "search", + "subcategory": "search" + } } }, - "/teams/{team_id}/discussions": { + "/teams/{team_id}": { "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "Get a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -625706,38 +620926,6 @@ "schema": { "type": "integer" } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/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": { @@ -625746,545 +620934,115 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/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": [ { @@ -626699,548 +621738,941 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + 1 + ] + }, + "node_id": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/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": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -627248,378 +622680,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -627950,11 +623850,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -627964,45 +623877,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628060,12 +623994,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" ] @@ -628095,19 +624034,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, @@ -628140,20 +624084,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": [ { @@ -628164,15 +624108,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -628182,19 +624117,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." } } } @@ -628207,8 +624153,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": { @@ -628387,16 +624333,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -628406,11 +624352,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -628420,45 +624379,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628516,12 +624496,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" ] @@ -628549,19 +624534,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, @@ -628586,22 +624576,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": [ { @@ -628621,15 +624611,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -628638,8 +624619,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": { @@ -628818,16 +624799,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -628837,11 +624818,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -628851,45 +624845,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628947,12 +624962,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" ] @@ -628980,19 +625000,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, @@ -629016,20 +625041,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": [ { @@ -629049,37 +625074,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" } } } @@ -629092,8 +625109,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": { @@ -629272,16 +625289,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -629291,11 +625308,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -629305,45 +625335,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -629401,12 +625452,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" ] @@ -629434,19 +625490,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, @@ -629470,20 +625531,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": [ { @@ -629503,15 +625564,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -629525,22 +625577,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": [ { @@ -629562,31 +625614,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" } }, { @@ -629616,23 +625654,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -629807,104 +625833,678 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" + "eyes", + "rocket" ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + } + } + } + }, + "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": "discussion-comments" + }, + "deprecated": true + }, + "post": { + "summary": "Create a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/create-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy" + }, + "parameters": [ + { + "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": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like apples?" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "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": { + "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 - }, - "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.", + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/get-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#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -629935,65 +626535,17 @@ } } ], - "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": { + "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -630168,45 +626720,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -630226,8 +626883,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 + } } } } @@ -630238,25 +626916,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 - } - }, - "/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.", + }, + "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/list-for-team-discussion-legacy", + "operationId": "teams/update-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#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -630278,354 +626954,8 @@ } }, { - "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", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - ] - } - } - } - }, - "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" - }, - "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": [ - { - "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.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -630640,29 +626970,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?" } } } @@ -630670,28 +626990,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -630866,45 +627174,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -630924,8 +627337,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 + } } } } @@ -630935,11 +627369,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index de4cff6a1..831f26f6e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -9169,7 +9169,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &462 + - &460 name: has in: query description: |- @@ -9289,7 +9289,7 @@ paths: - direct - transitive - - security_advisory: &463 + security_advisory: &461 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9557,7 +9557,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &464 + auto_dismissed_at: &462 type: - string - 'null' @@ -9565,7 +9565,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &465 + dismissal_request: &463 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -11895,7 +11895,7 @@ paths: action: type: string issue: *70 - comment: &512 + comment: &510 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -16660,14 +16660,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &318 + - &314 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &319 + - &315 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16729,7 +16729,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &322 + '301': &318 description: Moved permanently content: application/json: @@ -20201,7 +20201,7 @@ paths: type: integer repository_cache_usages: type: array - items: &329 + items: &325 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21439,7 +21439,7 @@ paths: - all - local_only - selected - selected_actions_url: &335 + selected_actions_url: &331 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -21522,7 +21522,7 @@ paths: description: Response content: application/json: - schema: &339 + schema: &335 type: object properties: days: @@ -21564,7 +21564,7 @@ paths: required: true content: application/json: - schema: &340 + schema: &336 type: object properties: days: @@ -21621,7 +21621,7 @@ paths: required: - approval_policy examples: - default: &341 + default: &337 value: approval_policy: first_time_contributors '404': *6 @@ -21680,7 +21680,7 @@ paths: description: Response content: application/json: - schema: &342 + schema: &338 type: object required: - run_workflows_from_fork_pull_requests @@ -21734,7 +21734,7 @@ paths: required: true content: application/json: - schema: &343 + schema: &339 type: object required: - run_workflows_from_fork_pull_requests @@ -22369,7 +22369,7 @@ paths: description: Response content: application/json: - schema: &344 + schema: &340 type: object properties: default_workflow_permissions: &137 @@ -22420,7 +22420,7 @@ paths: required: false content: application/json: - schema: &345 + schema: &341 type: object properties: default_workflow_permissions: *137 @@ -23560,7 +23560,7 @@ paths: application/json: schema: type: array - items: &346 + items: &342 title: Runner Application description: Runner Application type: object @@ -23585,7 +23585,7 @@ paths: - download_url - filename examples: - default: &347 + default: &343 value: - os: osx architecture: x64 @@ -23671,7 +23671,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &348 + '201': &344 description: Response content: application/json: @@ -23786,7 +23786,7 @@ paths: - token - expires_at examples: - default: &349 + default: &345 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23825,7 +23825,7 @@ paths: application/json: schema: *148 examples: - default: &350 + default: &346 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23859,7 +23859,7 @@ paths: application/json: schema: *146 examples: - default: &351 + default: &347 value: id: 23 name: MBP @@ -24085,7 +24085,7 @@ paths: - *65 - *145 responses: - '200': &352 + '200': &348 description: Response content: application/json: @@ -24142,7 +24142,7 @@ paths: parameters: - *65 - *145 - - &353 + - &349 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24274,7 +24274,7 @@ paths: description: Response content: application/json: - schema: &365 + schema: &361 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24309,7 +24309,7 @@ paths: - key_id - key examples: - default: &366 + default: &362 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24722,7 +24722,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *65 - - &334 + - &330 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)." @@ -26290,7 +26290,7 @@ paths: initiator: type: string examples: - default: &379 + default: &375 value: attestations: - bundle: @@ -27246,7 +27246,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *65 - - &403 + - &399 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`, @@ -27256,7 +27256,7 @@ paths: schema: &169 type: string description: The name of the tool used to generate the code scanning analysis. - - &404 + - &400 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 @@ -27280,7 +27280,7 @@ paths: be returned. in: query required: false - schema: &406 + schema: &402 type: string description: State of a code scanning alert. enum: @@ -27303,7 +27303,7 @@ paths: be returned. in: query required: false - schema: &407 + schema: &403 type: string description: Severity of a code scanning alert. enum: @@ -27337,7 +27337,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: &408 + instances_url: &404 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -27359,7 +27359,7 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: &409 + dismissed_reason: &405 type: - string - 'null' @@ -27370,14 +27370,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &410 + dismissed_comment: &406 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &411 + rule: &407 type: object properties: id: @@ -27438,7 +27438,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &412 + tool: &408 type: object properties: name: *169 @@ -27449,26 +27449,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *170 - most_recent_instance: &413 + most_recent_instance: &409 type: object properties: - ref: &405 + ref: &401 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &423 + analysis_key: &419 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: &424 + environment: &420 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: &425 + category: &421 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -27482,7 +27482,7 @@ paths: properties: text: type: string - location: &426 + location: &422 type: object description: Describe a region within a file for the alert. properties: @@ -27503,7 +27503,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: &427 + items: &423 type: - string - 'null' @@ -28796,7 +28796,7 @@ paths: machine: anyOf: - type: 'null' - - &439 + - &435 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -29748,7 +29748,7 @@ paths: - updated_at - visibility examples: - default: &440 + default: &436 value: total_count: 2 secrets: @@ -29786,7 +29786,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &437 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29821,7 +29821,7 @@ paths: - key_id - key examples: - default: &442 + default: &438 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29853,7 +29853,7 @@ paths: application/json: schema: *179 examples: - default: &444 + default: &440 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -31476,7 +31476,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &466 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -31495,7 +31495,7 @@ paths: - key_id - key examples: - default: &469 + default: &467 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33323,7 +33323,7 @@ paths: application/json: schema: *20 examples: - default: &507 + default: &505 value: id: 1 account: @@ -33551,7 +33551,7 @@ paths: required: true content: application/json: - schema: &508 + schema: &506 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -34411,7 +34411,7 @@ paths: application/json: schema: *221 examples: - default: &438 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -38873,7 +38873,7 @@ paths: content: oneOf: - *70 - - &451 + - &449 title: Pull Request Simple description: Pull Request Simple type: object @@ -41945,7 +41945,7 @@ paths: description: Response content: application/json: - schema: &321 + schema: &317 title: Full Repository description: Full Repository type: object @@ -42410,7 +42410,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &456 + code_of_conduct: &454 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -42524,7 +42524,7 @@ paths: - network_count - subscribers_count examples: - default: &323 + default: &319 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49041,408 +49041,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: - - *65 - - *66 - - *309 - - *312 - - 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: &313 - 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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - *4 - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &315 - 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: *56 - 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: - - *65 - - *66 - - *309 - - *312 - 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: *313 - examples: - default: &314 - 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: *313 - examples: - default: *314 - 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: - - *65 - - *66 - - *309 - - *312 - - &316 - 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: - - *65 - - *66 - - *309 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *65 - - *66 - - *309 - 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: *313 - examples: - default: *314 - '201': - description: Response - content: - application/json: - schema: *313 - examples: - default: *314 - 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: - - *65 - - *66 - - *309 - - *316 - 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 @@ -49555,7 +49153,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &313 title: Team Membership description: Team Membership type: object @@ -49646,7 +49244,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-users-membership-with-team-is-now-pending: &642 summary: Response if user's membership with team is now pending @@ -49755,8 +49353,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Alternative response with repository permissions @@ -50405,8 +50003,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -50453,8 +50051,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -50645,7 +50243,7 @@ paths: resources: type: object properties: - core: &320 + core: &316 title: Rate Limit type: object properties: @@ -50662,21 +50260,21 @@ paths: - remaining - reset - used - graphql: *320 - search: *320 - code_search: *320 - source_import: *320 - integration_manifest: *320 - code_scanning_upload: *320 - actions_runner_registration: *320 - scim: *320 - dependency_snapshots: *320 - dependency_sbom: *320 - code_scanning_autofix: *320 + graphql: *316 + search: *316 + code_search: *316 + source_import: *316 + integration_manifest: *316 + code_scanning_upload: *316 + actions_runner_registration: *316 + scim: *316 + dependency_snapshots: *316 + dependency_sbom: *316 + code_scanning_autofix: *316 required: - core - search - rate: *320 + rate: *316 required: - rate - resources @@ -50781,14 +50379,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *321 + schema: *317 examples: default-response: summary: Default response @@ -51289,7 +50887,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *322 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51307,8 +50905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -51556,10 +51154,10 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 - '307': &324 + default: *319 + '307': &320 description: Temporary Redirect content: application/json: @@ -51588,8 +51186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -51611,7 +51209,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *324 + '307': *320 '404': *6 '409': *49 x-github: @@ -51635,11 +51233,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - - &357 + - &353 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51662,7 +51260,7 @@ paths: type: integer artifacts: type: array - items: &325 + items: &321 title: Artifact description: An artifact type: object @@ -51757,7 +51355,7 @@ paths: - expires_at - updated_at examples: - default: &358 + default: &354 value: total_count: 2 artifacts: @@ -51818,9 +51416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *318 - - *319 - - &326 + - *314 + - *315 + - &322 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51832,7 +51430,7 @@ paths: description: Response content: application/json: - schema: *325 + schema: *321 examples: default: value: @@ -51870,9 +51468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *318 - - *319 - - *326 + - *314 + - *315 + - *322 responses: '204': description: Response @@ -51896,9 +51494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *318 - - *319 - - *326 + - *314 + - *315 + - *322 - name: archive_format in: path required: true @@ -51912,7 +51510,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': &511 + '410': &509 description: Gone content: application/json: @@ -51937,14 +51535,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &327 + schema: &323 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51978,13 +51576,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *327 + schema: *323 examples: selected_actions: *40 responses: @@ -52013,14 +51611,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &328 + schema: &324 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52054,13 +51652,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *328 + schema: *324 examples: selected_actions: *42 responses: @@ -52091,14 +51689,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *329 + schema: *325 examples: default: value: @@ -52124,11 +51722,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - - &330 + - &326 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 @@ -52162,7 +51760,7 @@ paths: description: Response content: application/json: - schema: &331 + schema: &327 title: Repository actions caches description: Repository actions caches type: object @@ -52212,7 +51810,7 @@ paths: - total_count - actions_caches examples: - default: &332 + default: &328 value: total_count: 1 actions_caches: @@ -52244,23 +51842,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: - - *318 - - *319 + - *314 + - *315 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *330 + - *326 responses: '200': description: Response content: application/json: - schema: *331 + schema: *327 examples: - default: *332 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52280,8 +51878,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: - - *318 - - *319 + - *314 + - *315 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52312,9 +51910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *318 - - *319 - - &333 + - *314 + - *315 + - &329 name: job_id description: The unique identifier of the job. in: path @@ -52326,7 +51924,7 @@ paths: description: Response content: application/json: - schema: &361 + schema: &357 title: Job description: Information of a job execution in a workflow run type: object @@ -52673,9 +52271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *318 - - *319 - - *333 + - *314 + - *315 + - *329 responses: '302': description: Response @@ -52703,9 +52301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *318 - - *319 - - *333 + - *314 + - *315 + - *329 requestBody: required: false content: @@ -52751,8 +52349,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Status response @@ -52802,8 +52400,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -52866,8 +52464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -52885,7 +52483,7 @@ paths: type: integer secrets: type: array - items: &363 + items: &359 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -52906,7 +52504,7 @@ paths: - created_at - updated_at examples: - default: &364 + default: &360 value: total_count: 2 secrets: @@ -52939,9 +52537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *318 - - *319 - - *334 + - *314 + - *315 + - *330 - *19 responses: '200': @@ -52958,7 +52556,7 @@ paths: type: integer variables: type: array - items: &367 + items: &363 title: Actions Variable type: object properties: @@ -52992,7 +52590,7 @@ paths: - created_at - updated_at examples: - default: &368 + default: &364 value: total_count: 2 variables: @@ -53025,8 +52623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53035,11 +52633,11 @@ paths: schema: type: object properties: - enabled: &336 + enabled: &332 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *129 - selected_actions_url: *335 + selected_actions_url: *331 sha_pinning_required: *130 required: - enabled @@ -53068,8 +52666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53080,7 +52678,7 @@ paths: schema: type: object properties: - enabled: *336 + enabled: *332 allowed_actions: *129 sha_pinning_required: *130 required: @@ -53112,14 +52710,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &337 + schema: &333 type: object properties: access_level: @@ -53136,7 +52734,7 @@ paths: required: - access_level examples: - default: &338 + default: &334 value: access_level: organization x-github: @@ -53160,15 +52758,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *337 + schema: *333 examples: - default: *338 + default: *334 responses: '204': description: Response @@ -53192,14 +52790,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *339 + schema: *335 examples: default: value: @@ -53223,8 +52821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Empty response for successful settings update @@ -53234,7 +52832,7 @@ paths: required: true content: application/json: - schema: *340 + schema: *336 examples: default: summary: Set retention days @@ -53258,8 +52856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53267,7 +52865,7 @@ paths: application/json: schema: *131 examples: - default: *341 + default: *337 '404': *6 x-github: enabledForGitHubApps: true @@ -53286,8 +52884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53321,14 +52919,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *342 + schema: *338 examples: default: *132 '403': *27 @@ -53350,13 +52948,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *343 + schema: *339 examples: default: *132 responses: @@ -53382,8 +52980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53410,8 +53008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53443,14 +53041,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *344 + schema: *340 examples: default: *139 x-github: @@ -53473,8 +53071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Success response @@ -53485,7 +53083,7 @@ paths: required: true content: application/json: - schema: *345 + schema: *341 examples: default: *139 x-github: @@ -53514,8 +53112,8 @@ paths: in: query schema: type: string - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -53559,8 +53157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53568,9 +53166,9 @@ paths: application/json: schema: type: array - items: *346 + items: *342 examples: - default: *347 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53592,8 +53190,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -53636,7 +53234,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *348 + '201': *344 '404': *6 '422': *7 '409': *49 @@ -53667,8 +53265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -53676,7 +53274,7 @@ paths: application/json: schema: *148 examples: - default: *349 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53704,8 +53302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -53713,7 +53311,7 @@ paths: application/json: schema: *148 examples: - default: *350 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53735,8 +53333,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '200': @@ -53745,7 +53343,7 @@ paths: application/json: schema: *146 examples: - default: *351 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53766,8 +53364,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '204': @@ -53794,8 +53392,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '200': *150 @@ -53820,8 +53418,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: - - *318 - - *319 + - *314 + - *315 - *145 requestBody: required: true @@ -53870,8 +53468,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: - - *318 - - *319 + - *314 + - *315 - *145 requestBody: required: true @@ -53921,11 +53519,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: - '200': *352 + '200': *348 '404': *6 x-github: githubCloudOnly: false @@ -53952,10 +53550,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: - - *318 - - *319 + - *314 + - *315 - *145 - - *353 + - *349 responses: '200': *150 '404': *6 @@ -53983,9 +53581,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *318 - - *319 - - &371 + - *314 + - *315 + - &367 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. @@ -53993,7 +53591,7 @@ paths: required: false schema: type: string - - &372 + - &368 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54001,7 +53599,7 @@ paths: required: false schema: type: string - - &373 + - &369 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54010,7 +53608,7 @@ paths: required: false schema: type: string - - &374 + - &370 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 @@ -54037,7 +53635,7 @@ paths: - pending - *17 - *19 - - &375 + - &371 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)." @@ -54046,7 +53644,7 @@ paths: schema: type: string format: date-time - - &354 + - &350 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54055,13 +53653,13 @@ paths: schema: type: boolean default: false - - &376 + - &372 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &377 + - &373 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54084,7 +53682,7 @@ paths: type: integer workflow_runs: type: array - items: &355 + items: &351 title: Workflow Run description: An invocation of a workflow type: object @@ -54262,7 +53860,7 @@ paths: head_commit: anyOf: - type: 'null' - - &399 + - &395 title: Simple Commit description: A commit. type: object @@ -54377,7 +53975,7 @@ paths: - workflow_url - pull_requests examples: - default: &378 + default: &374 value: total_count: 1 workflow_runs: @@ -54613,24 +54211,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *318 - - *319 - - &356 + - *314 + - *315 + - &352 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *354 + - *350 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: - default: &359 + default: &355 value: id: 30433642 name: Build @@ -54871,9 +54469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '204': description: Response @@ -54896,9 +54494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -55026,9 +54624,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: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '201': description: Response @@ -55061,12 +54659,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 - *17 - *19 - - *357 + - *353 responses: '200': description: Response @@ -55082,9 +54680,9 @@ paths: type: integer artifacts: type: array - items: *325 + items: *321 examples: - default: *358 + default: *354 headers: Link: *56 x-github: @@ -55108,25 +54706,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *318 - - *319 - - *356 - - &360 + - *314 + - *315 + - *352 + - &356 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *354 + - *350 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: - default: *359 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55149,10 +54747,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *318 - - *319 + - *314 + - *315 + - *352 - *356 - - *360 - *17 - *19 responses: @@ -55170,9 +54768,9 @@ paths: type: integer jobs: type: array - items: *361 + items: *357 examples: - default: &362 + default: &358 value: total_count: 1 jobs: @@ -55285,10 +54883,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *318 - - *319 + - *314 + - *315 + - *352 - *356 - - *360 responses: '302': description: Response @@ -55316,9 +54914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '202': description: Response @@ -55351,9 +54949,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: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: true content: @@ -55420,9 +55018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '202': description: Response @@ -55455,9 +55053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 - 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 @@ -55487,9 +55085,9 @@ paths: type: integer jobs: type: array - items: *361 + items: *357 examples: - default: *362 + default: *358 headers: Link: *56 x-github: @@ -55514,9 +55112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '302': description: Response @@ -55543,9 +55141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '204': description: Response @@ -55572,9 +55170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -55643,7 +55241,7 @@ paths: items: type: object properties: - type: &477 + type: &475 type: string description: The type of reviewer. enum: @@ -55729,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: true content: @@ -55781,7 +55379,7 @@ paths: application/json: schema: type: array - items: &472 + items: &470 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -55893,7 +55491,7 @@ paths: - created_at - updated_at examples: - default: &473 + default: &471 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55949,9 +55547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: false content: @@ -55996,9 +55594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: false content: @@ -56052,9 +55650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -56191,8 +55789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -56210,9 +55808,9 @@ paths: type: integer secrets: type: array - items: *363 + items: *359 examples: - default: *364 + default: *360 headers: Link: *56 x-github: @@ -56237,16 +55835,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *365 + schema: *361 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56268,17 +55866,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *363 + schema: *359 examples: - default: &490 + default: &488 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56304,8 +55902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -56363,8 +55961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -56390,9 +55988,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *318 - - *319 - - *334 + - *314 + - *315 + - *330 - *19 responses: '200': @@ -56409,9 +56007,9 @@ paths: type: integer variables: type: array - items: *367 + items: *363 examples: - default: *368 + default: *364 headers: Link: *56 x-github: @@ -56434,8 +56032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -56487,17 +56085,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 responses: '200': description: Response content: application/json: - schema: *367 + schema: *363 examples: - default: &491 + default: &489 value: name: USERNAME value: octocat @@ -56523,8 +56121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 requestBody: required: true @@ -56567,8 +56165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 responses: '204': @@ -56594,8 +56192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -56613,7 +56211,7 @@ paths: type: integer workflows: type: array - items: &369 + items: &365 title: Workflow description: A GitHub Actions workflow type: object @@ -56731,9 +56329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *318 - - *319 - - &370 + - *314 + - *315 + - &366 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56748,7 +56346,7 @@ paths: description: Response content: application/json: - schema: *369 + schema: *365 examples: default: value: @@ -56781,9 +56379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56808,9 +56406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56861,9 +56459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56890,19 +56488,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *318 - - *319 + - *314 + - *315 + - *366 + - *367 + - *368 + - *369 - *370 + - *17 + - *19 - *371 + - *350 - *372 - *373 - - *374 - - *17 - - *19 - - *375 - - *354 - - *376 - - *377 responses: '200': description: Response @@ -56918,9 +56516,9 @@ paths: type: integer workflow_runs: type: array - items: *355 + items: *351 examples: - default: *378 + default: *374 headers: Link: *56 x-github: @@ -56952,9 +56550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '200': description: Response @@ -57015,8 +56613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *318 - - *319 + - *314 + - *315 - *50 - *17 - *43 @@ -57184,8 +56782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -57222,8 +56820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *318 - - *319 + - *314 + - *315 - name: assignee in: path required: true @@ -57259,8 +56857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -57372,8 +56970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *43 - *44 @@ -57430,7 +57028,7 @@ paths: initiator: type: string examples: - default: *379 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57450,8 +57048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -57459,7 +57057,7 @@ paths: application/json: schema: type: array - items: &380 + items: &376 title: Autolink reference description: An autolink reference. type: object @@ -57518,8 +57116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -57558,9 +57156,9 @@ paths: description: response content: application/json: - schema: *380 + schema: *376 examples: - default: &381 + default: &377 value: id: 1 key_prefix: TICKET- @@ -57591,9 +57189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *318 - - *319 - - &382 + - *314 + - *315 + - &378 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57605,9 +57203,9 @@ paths: description: Response content: application/json: - schema: *380 + schema: *376 examples: - default: *381 + default: *377 '404': *6 x-github: githubCloudOnly: false @@ -57627,9 +57225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *318 - - *319 - - *382 + - *314 + - *315 + - *378 responses: '204': description: Response @@ -57653,8 +57251,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response if Dependabot is enabled @@ -57704,8 +57302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -57726,8 +57324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -57747,8 +57345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *318 - - *319 + - *314 + - *315 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57786,7 +57384,7 @@ paths: - url protected: type: boolean - protection: &384 + protection: &380 title: Branch Protection description: Branch Protection type: object @@ -57829,7 +57427,7 @@ paths: required: - contexts - checks - enforce_admins: &387 + enforce_admins: &383 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57846,7 +57444,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &389 + required_pull_request_reviews: &385 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57930,7 +57528,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &386 + restrictions: &382 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58223,9 +57821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *318 - - *319 - - &385 + - *314 + - *315 + - &381 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). @@ -58239,14 +57837,14 @@ paths: description: Response content: application/json: - schema: &395 + schema: &391 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &447 + commit: &445 title: Commit description: Commit type: object @@ -58285,7 +57883,7 @@ paths: author: anyOf: - type: 'null' - - &383 + - &379 title: Git User description: Metaproperties for Git author/committer information. @@ -58307,7 +57905,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 message: type: string examples: @@ -58331,7 +57929,7 @@ paths: required: - sha - url - verification: &497 + verification: &495 title: Verification type: object properties: @@ -58411,7 +58009,7 @@ paths: type: integer files: type: array - items: &458 + items: &456 title: Diff Entry description: Diff Entry type: object @@ -58507,7 +58105,7 @@ paths: - self protected: type: boolean - protection: *384 + protection: *380 protection_url: type: string format: uri @@ -58616,7 +58214,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *322 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -58638,15 +58236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *384 + schema: *380 examples: default: value: @@ -58840,9 +58438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -59102,7 +58700,7 @@ paths: url: type: string format: uri - required_status_checks: &392 + required_status_checks: &388 title: Status Check Policy description: Status Check Policy type: object @@ -59261,7 +58859,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *386 + restrictions: *382 required_conversation_resolution: type: object properties: @@ -59373,9 +58971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59400,17 +58998,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: &388 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -59432,17 +59030,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: *388 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59461,9 +59059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59488,17 +59086,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *389 + schema: *385 examples: - default: &390 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59594,9 +59192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -59694,9 +59292,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *385 examples: - default: *390 + default: *386 '422': *15 x-github: githubCloudOnly: false @@ -59717,9 +59315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59746,17 +59344,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: &391 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59779,17 +59377,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: *391 + default: *387 '404': *6 x-github: githubCloudOnly: false @@ -59809,9 +59407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59836,17 +59434,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *392 + schema: *388 examples: - default: &393 + default: &389 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59872,9 +59470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -59926,9 +59524,9 @@ paths: description: Response content: application/json: - schema: *392 + schema: *388 examples: - default: *393 + default: *389 '404': *6 '422': *15 x-github: @@ -59950,9 +59548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59976,9 +59574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60012,9 +59610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60081,9 +59679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60147,9 +59745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: content: application/json: @@ -60215,15 +59813,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *386 + schema: *382 examples: default: value: @@ -60314,9 +59912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -60339,9 +59937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60351,7 +59949,7 @@ paths: type: array items: *5 examples: - default: &394 + default: &390 value: - id: 1 slug: octoapp @@ -60408,9 +60006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60444,7 +60042,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60465,9 +60063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60501,7 +60099,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60522,9 +60120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60558,7 +60156,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60580,9 +60178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60612,9 +60210,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60673,9 +60271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60734,9 +60332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: content: application/json: @@ -60795,9 +60393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60831,9 +60429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60891,9 +60489,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60951,9 +60549,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -61013,9 +60611,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -61037,7 +60635,7 @@ paths: description: Response content: application/json: - schema: *395 + schema: *391 examples: default: value: @@ -61153,8 +60751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -61433,7 +61031,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &392 title: CheckRun description: A check performed on the code of a given code change type: object @@ -61856,9 +61454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *318 - - *319 - - &397 + - *314 + - *315 + - &393 name: check_run_id description: The unique identifier of the check run. in: path @@ -61870,9 +61468,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: &398 + default: &394 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61972,9 +61570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 requestBody: required: true content: @@ -62214,9 +61812,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: *398 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62236,9 +61834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 - *17 - *19 responses: @@ -62348,9 +61946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 responses: '201': description: Response @@ -62394,8 +61992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -62417,7 +62015,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &400 + schema: &396 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -62515,7 +62113,7 @@ paths: - string - 'null' format: date-time - head_commit: *399 + head_commit: *395 latest_check_runs_count: type: integer check_runs_url: @@ -62543,7 +62141,7 @@ paths: - check_runs_url - pull_requests examples: - default: &401 + default: &397 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62834,9 +62432,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *400 + schema: *396 examples: - default: *401 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62855,8 +62453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -63165,9 +62763,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *318 - - *319 - - &402 + - *314 + - *315 + - &398 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63179,9 +62777,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *396 examples: - default: *401 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63204,17 +62802,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *318 - - *319 - - *402 - - &453 + - *314 + - *315 + - *398 + - &451 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &454 + - &452 name: status description: Returns check runs with the specified `status`. in: query @@ -63253,9 +62851,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *392 examples: - default: &455 + default: &453 value: total_count: 1 check_runs: @@ -63357,9 +62955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *318 - - *319 - - *402 + - *314 + - *315 + - *398 responses: '201': description: Response @@ -63392,21 +62990,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *318 - - *319 - - *403 - - *404 + - *314 + - *315 + - *399 + - *400 - *19 - *17 - - &421 + - &417 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: *405 - - &422 + schema: *401 + - &418 name: pr description: The number of the pull request for the results you want to list. in: query @@ -63431,13 +63029,13 @@ paths: be returned. in: query required: false - schema: *406 + schema: *402 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *407 + schema: *403 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -63461,7 +63059,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: *408 + instances_url: *404 state: *171 fixed_at: *167 dismissed_by: @@ -63469,11 +63067,11 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: *409 - dismissed_comment: *410 - rule: *411 - tool: *412 - most_recent_instance: *413 + dismissed_reason: *405 + dismissed_comment: *406 + rule: *407 + tool: *408 + most_recent_instance: *409 dismissal_approved_by: anyOf: - type: 'null' @@ -63596,7 +63194,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &414 + '403': &410 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -63623,9 +63221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *318 - - *319 - - &415 + - *314 + - *315 + - &411 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63639,7 +63237,7 @@ paths: description: Response content: application/json: - schema: &416 + schema: &412 type: object properties: number: *162 @@ -63647,7 +63245,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: *408 + instances_url: *404 state: *171 fixed_at: *167 dismissed_by: @@ -63655,8 +63253,8 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: *409 - dismissed_comment: *410 + dismissed_reason: *405 + dismissed_comment: *406 rule: type: object properties: @@ -63718,8 +63316,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *412 - most_recent_instance: *413 + tool: *408 + most_recent_instance: *409 dismissal_approved_by: anyOf: - type: 'null' @@ -63815,7 +63413,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -63835,9 +63433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: true content: @@ -63852,8 +63450,8 @@ paths: enum: - open - dismissed - dismissed_reason: *409 - dismissed_comment: *410 + dismissed_reason: *405 + dismissed_comment: *406 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63881,7 +63479,7 @@ paths: description: Response content: application/json: - schema: *416 + schema: *412 examples: default: value: @@ -63957,7 +63555,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &420 + '403': &416 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -63984,15 +63582,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 responses: '200': description: Response content: application/json: - schema: &417 + schema: &413 type: object properties: status: @@ -64019,13 +63617,13 @@ paths: - description - started_at examples: - default: &418 + default: &414 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &419 + '400': &415 description: Bad Request content: application/json: @@ -64036,7 +63634,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': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64061,29 +63659,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 responses: '200': description: OK content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 '202': description: Accepted content: application/json: - schema: *417 + schema: *413 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *419 + '400': *415 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64115,9 +63713,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: false content: @@ -64163,8 +63761,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *419 - '403': *420 + '400': *415 + '403': *416 '404': *6 '422': description: Unprocessable Entity @@ -64188,13 +63786,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *19 - *17 - - *421 - - *422 + - *417 + - *418 responses: '200': description: Response @@ -64205,10 +63803,10 @@ paths: items: type: object properties: - ref: *405 - analysis_key: *423 - environment: *424 - category: *425 + ref: *401 + analysis_key: *419 + environment: *420 + category: *421 state: type: - string @@ -64225,7 +63823,7 @@ paths: properties: text: type: string - location: *426 + location: *422 html_url: type: string classifications: @@ -64233,7 +63831,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: *427 + items: *423 examples: default: value: @@ -64272,7 +63870,7 @@ paths: end_column: 50 classifications: - source - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64306,25 +63904,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *318 - - *319 - - *403 - - *404 + - *314 + - *315 + - *399 + - *400 - *19 - *17 - - *422 + - *418 - 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: *405 + schema: *401 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &428 + schema: &424 type: string description: An identifier for the upload. examples: @@ -64346,23 +63944,23 @@ paths: application/json: schema: type: array - items: &429 + items: &425 type: object properties: - ref: *405 - commit_sha: &437 + ref: *401 + commit_sha: &433 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: *423 + analysis_key: *419 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *425 + category: *421 error: type: string examples: @@ -64387,8 +63985,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *428 - tool: *412 + sarif_id: *424 + tool: *408 deletable: type: boolean warning: @@ -64450,7 +64048,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64486,8 +64084,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: - - *318 - - *319 + - *314 + - *315 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64500,7 +64098,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *425 examples: response: summary: application/json response @@ -64554,7 +64152,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *414 + '403': *410 '404': *6 '422': description: Response if analysis could not be processed @@ -64641,8 +64239,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: - - *318 - - *319 + - *314 + - *315 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64698,7 +64296,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': *420 + '403': *416 '404': *6 '503': *105 x-github: @@ -64720,8 +64318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -64729,7 +64327,7 @@ paths: application/json: schema: type: array - items: &430 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -64841,7 +64439,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': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64870,8 +64468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: language in: path description: The language of the CodeQL database. @@ -64883,7 +64481,7 @@ paths: description: Response content: application/json: - schema: *430 + schema: *426 examples: default: value: @@ -64915,9 +64513,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': &460 + '302': &458 description: Found - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64939,8 +64537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *318 - - *319 + - *314 + - *315 - name: language in: path description: The language of the CodeQL database. @@ -64950,7 +64548,7 @@ paths: responses: '204': description: Response - '403': *420 + '403': *416 '404': *6 '503': *105 x-github: @@ -64978,8 +64576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -64988,7 +64586,7 @@ paths: type: object additionalProperties: false properties: - language: &431 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -65068,7 +64666,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &435 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -65078,7 +64676,7 @@ paths: description: The ID of the variant analysis. controller_repo: *55 actor: *4 - query_language: *431 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -65126,7 +64724,7 @@ paths: items: type: object properties: - repository: &432 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -65168,7 +64766,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &436 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65200,7 +64798,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &433 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -65215,7 +64813,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: *432 + items: *428 required: - repository_count - repositories @@ -65238,8 +64836,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *433 - over_limit_repos: *433 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -65255,7 +64853,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &434 + value: &430 summary: Default response value: id: 1 @@ -65401,10 +64999,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *434 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *434 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission @@ -65432,8 +65030,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: - - *318 - - *319 + - *314 + - *315 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -65445,9 +65043,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *431 examples: - default: *434 + default: *430 '404': *6 '503': *105 x-github: @@ -65470,7 +65068,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: - - *318 + - *314 - name: repo in: path description: The name of the controller repository. @@ -65505,7 +65103,7 @@ paths: type: object properties: repository: *55 - analysis_status: *436 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65630,8 +65228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -65724,7 +65322,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -65745,8 +65343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -65840,7 +65438,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *420 + '403': *416 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65911,8 +65509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -65920,7 +65518,7 @@ paths: schema: type: object properties: - commit_sha: *437 + commit_sha: *433 ref: type: string description: |- @@ -65980,7 +65578,7 @@ paths: schema: type: object properties: - id: *428 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -65994,7 +65592,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': *420 + '403': *416 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -66017,8 +65615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *318 - - *319 + - *314 + - *315 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -66066,7 +65664,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': *414 + '403': *410 '404': description: Not Found if the sarif id does not match any upload '503': *105 @@ -66091,8 +65689,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66173,8 +65771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *318 - - *319 + - *314 + - *315 - 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 @@ -66302,8 +65900,8 @@ paths: parameters: - *17 - *19 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66617,8 +66215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -66684,7 +66282,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -66692,7 +66290,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '400': *14 '401': *23 '403': *27 @@ -66721,8 +66319,8 @@ paths: parameters: - *17 - *19 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66786,8 +66384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66824,7 +66422,7 @@ paths: type: integer machines: type: array - items: *439 + items: *435 examples: default: &651 value: @@ -66866,8 +66464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *318 - - *319 + - *314 + - *315 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66954,8 +66552,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: - - *318 - - *319 + - *314 + - *315 - 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 @@ -67024,8 +66622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -67043,7 +66641,7 @@ paths: type: integer secrets: type: array - items: &443 + items: &439 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -67064,7 +66662,7 @@ paths: - created_at - updated_at examples: - default: *440 + default: *436 headers: Link: *56 x-github: @@ -67087,16 +66685,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *441 + schema: *437 examples: - default: *442 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67116,17 +66714,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *443 + schema: *439 examples: - default: *444 + default: *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67146,8 +66744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -67200,8 +66798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -67230,8 +66828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *318 - - *319 + - *314 + - *315 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67269,7 +66867,7 @@ paths: application/json: schema: type: array - items: &445 + items: &441 title: Collaborator description: Collaborator type: object @@ -67462,8 +67060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '204': @@ -67510,8 +67108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 requestBody: required: false @@ -67538,7 +67136,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &510 + schema: &508 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -67766,8 +67364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '204': @@ -67799,8 +67397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '200': @@ -67821,7 +67419,7 @@ paths: user: anyOf: - type: 'null' - - *445 + - *441 required: - permission - role_name @@ -67875,8 +67473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -67886,7 +67484,7 @@ paths: application/json: schema: type: array - items: &446 + items: &442 title: Commit Comment description: Commit Comment type: object @@ -67944,7 +67542,7 @@ paths: - created_at - updated_at examples: - default: &449 + default: &447 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68003,17 +67601,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': description: Response content: application/json: - schema: *446 + schema: *442 examples: - default: &450 + default: &448 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68070,8 +67668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -68094,7 +67692,7 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: default: value: @@ -68145,8 +67743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -68168,8 +67766,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -68196,9 +67794,75 @@ paths: application/json: schema: type: array - items: *313 + items: &443 + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - *4 + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *315 + default: &512 + 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: *56 '404': *6 @@ -68219,8 +67883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -68253,16 +67917,40 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: &444 + 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: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -68284,10 +67972,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - &513 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -68336,8 +68030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *318 - - *319 + - *314 + - *315 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -68393,7 +68087,7 @@ paths: application/json: schema: type: array - items: *447 + items: *445 examples: default: &559 value: @@ -68489,9 +68183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *318 - - *319 - - &448 + - *314 + - *315 + - &446 name: commit_sha description: The SHA of the commit. in: path @@ -68563,9 +68257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 - *17 - *19 responses: @@ -68575,9 +68269,9 @@ paths: application/json: schema: type: array - items: *446 + items: *442 examples: - default: *449 + default: *447 headers: Link: *56 x-github: @@ -68605,9 +68299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 requestBody: required: true content: @@ -68642,9 +68336,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: - default: *450 + default: *448 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68672,9 +68366,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 - *17 - *19 responses: @@ -68684,7 +68378,7 @@ paths: application/json: schema: type: array - items: *451 + items: *449 examples: default: &551 value: @@ -69223,11 +68917,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 - - &452 + - &450 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)" @@ -69242,7 +68936,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *445 examples: default: &537 value: @@ -69357,11 +69051,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *318 - - *319 + - *314 + - *315 + - *450 + - *451 - *452 - - *453 - - *454 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -69395,9 +69089,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *392 examples: - default: *455 + default: *453 headers: Link: *56 x-github: @@ -69422,9 +69116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -69432,7 +69126,7 @@ paths: schema: type: integer example: 1 - - *453 + - *451 - *17 - *19 responses: @@ -69450,7 +69144,7 @@ paths: type: integer check_suites: type: array - items: *400 + items: *396 examples: default: value: @@ -69650,9 +69344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - *17 - *19 responses: @@ -69854,9 +69548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - *17 - *19 responses: @@ -69947,7 +69641,7 @@ paths: site_admin: false headers: Link: *56 - '301': *322 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69975,8 +69669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -70009,11 +69703,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *456 + - *454 code_of_conduct_file: anyOf: - type: 'null' - - &457 + - &455 title: Community Health File type: object properties: @@ -70033,19 +69727,19 @@ paths: contributing: anyOf: - type: 'null' - - *457 + - *455 readme: anyOf: - type: 'null' - - *457 + - *455 issue_template: anyOf: - type: 'null' - - *457 + - *455 pull_request_template: anyOf: - type: 'null' - - *457 + - *455 required: - code_of_conduct - code_of_conduct_file @@ -70174,8 +69868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 - name: basehead @@ -70223,8 +69917,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *447 - merge_base_commit: *447 + base_commit: *445 + merge_base_commit: *445 status: type: string enum: @@ -70248,10 +69942,10 @@ paths: - 6 commits: type: array - items: *447 + items: *445 files: type: array - items: *458 + items: *456 required: - url - html_url @@ -70537,8 +70231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -70691,7 +70385,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &459 + response-if-content-is-a-file: &457 summary: Response if content is a file value: type: file @@ -71046,7 +70740,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *459 + response-if-content-is-a-file: *457 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71115,7 +70809,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *460 + '302': *458 '304': *35 x-github: githubCloudOnly: false @@ -71138,8 +70832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -71234,7 +70928,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &459 title: File Commit description: File Commit type: object @@ -71390,7 +71084,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: example-for-creating-a-file: value: @@ -71444,7 +71138,7 @@ paths: schema: oneOf: - *3 - - &492 + - &490 description: Repository rule violation was detected type: object properties: @@ -71497,8 +71191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -71559,7 +71253,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -71614,8 +71308,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *318 - - *319 + - *314 + - *315 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71739,8 +71433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *181 - *182 - *183 @@ -71752,7 +71446,7 @@ paths: schema: type: string - *185 - - *462 + - *460 - *186 - *187 - *50 @@ -71773,7 +71467,7 @@ paths: application/json: schema: type: array - items: &466 + items: &464 type: object description: A Dependabot alert. properties: @@ -71823,7 +71517,7 @@ paths: - direct - transitive - - security_advisory: *463 + security_advisory: *461 security_vulnerability: *54 url: *165 html_url: *166 @@ -71854,8 +71548,8 @@ paths: dismissal. maxLength: 280 fixed_at: *167 - auto_dismissed_at: *464 - dismissal_request: *465 + auto_dismissed_at: *462 + dismissal_request: *463 required: - number - state @@ -72085,9 +71779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *318 - - *319 - - &467 + - *314 + - *315 + - &465 name: alert_number in: path description: |- @@ -72102,7 +71796,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: value: @@ -72215,9 +71909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *318 - - *319 - - *467 + - *314 + - *315 + - *465 requestBody: required: true content: @@ -72262,7 +71956,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: value: @@ -72391,8 +72085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -72410,7 +72104,7 @@ paths: type: integer secrets: type: array - items: &470 + items: &468 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -72464,16 +72158,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: *469 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72493,15 +72187,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -72527,8 +72221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -72581,8 +72275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -72605,8 +72299,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: - - *318 - - *319 + - *314 + - *315 - 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 @@ -72780,8 +72474,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -73041,8 +72735,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -73125,7 +72819,7 @@ paths: - version - url additionalProperties: false - metadata: &471 + metadata: &469 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73164,7 +72858,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *471 + metadata: *469 resolved: type: object description: A collection of resolved package dependencies. @@ -73178,7 +72872,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *471 + metadata: *469 relationship: type: string description: A notation of whether a dependency is requested @@ -73311,8 +73005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *318 - - *319 + - *314 + - *315 - name: sha description: The SHA recorded at creation time. in: query @@ -73353,9 +73047,9 @@ paths: application/json: schema: type: array - items: *472 + items: *470 examples: - default: *473 + default: *471 headers: Link: *56 x-github: @@ -73421,8 +73115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -73504,7 +73198,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *470 examples: simple-example: summary: Simple example @@ -73577,9 +73271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *318 - - *319 - - &474 + - *314 + - *315 + - &472 name: deployment_id description: deployment_id parameter in: path @@ -73591,7 +73285,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *470 examples: default: value: @@ -73656,9 +73350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 responses: '204': description: Response @@ -73680,9 +73374,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 - *17 - *19 responses: @@ -73692,7 +73386,7 @@ paths: application/json: schema: type: array - items: &475 + items: &473 title: Deployment Status description: The status of a deployment. type: object @@ -73856,9 +73550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 requestBody: required: true content: @@ -73933,9 +73627,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *473 examples: - default: &476 + default: &474 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -73991,9 +73685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 - name: status_id in: path required: true @@ -74004,9 +73698,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *473 examples: - default: *476 + default: *474 '404': *6 x-github: githubCloudOnly: false @@ -74031,8 +73725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -74089,8 +73783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -74108,7 +73802,7 @@ paths: - 5 environments: type: array - items: &478 + items: &476 title: Environment description: Details of a deployment environment type: object @@ -74170,7 +73864,7 @@ paths: type: string examples: - wait_timer - wait_timer: &480 + wait_timer: &478 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -74212,7 +73906,7 @@ paths: items: type: object properties: - type: *477 + type: *475 reviewer: anyOf: - *4 @@ -74239,7 +73933,7 @@ paths: - id - node_id - type - deployment_branch_policy: &481 + deployment_branch_policy: &479 type: - object - 'null' @@ -74356,9 +74050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *318 - - *319 - - &479 + - *314 + - *315 + - &477 name: environment_name in: path required: true @@ -74371,9 +74065,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *476 examples: - default: &482 + default: &480 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -74457,9 +74151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: false content: @@ -74469,7 +74163,7 @@ paths: - object - 'null' properties: - wait_timer: *480 + wait_timer: *478 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -74488,14 +74182,14 @@ paths: items: type: object properties: - type: *477 + type: *475 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *481 + deployment_branch_policy: *479 additionalProperties: false examples: default: @@ -74515,9 +74209,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *476 examples: - default: *482 + default: *480 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -74541,9 +74235,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 responses: '204': description: Default response @@ -74568,9 +74262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *17 - *19 responses: @@ -74589,7 +74283,7 @@ paths: - 2 branch_policies: type: array - items: &483 + items: &481 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -74650,9 +74344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: true content: @@ -74700,9 +74394,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - example-wildcard: &484 + example-wildcard: &482 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74744,10 +74438,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - &485 + - *314 + - *315 + - *477 + - &483 name: branch_policy_id in: path required: true @@ -74759,9 +74453,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - default: *484 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74780,10 +74474,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - *485 + - *314 + - *315 + - *477 + - *483 requestBody: required: true content: @@ -74812,9 +74506,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - default: *484 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74833,10 +74527,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - *485 + - *314 + - *315 + - *477 + - *483 responses: '204': description: Response @@ -74861,9 +74555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 responses: '200': description: List of deployment protection rules @@ -74880,7 +74574,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &486 + items: &484 title: Deployment protection rule description: Deployment protection rule type: object @@ -74902,7 +74596,7 @@ paths: for the environment. examples: - true - app: &487 + app: &485 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -75005,9 +74699,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: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 requestBody: content: application/json: @@ -75028,9 +74722,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *486 + schema: *484 examples: - default: &488 + default: &486 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75065,9 +74759,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: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 - *19 - *17 responses: @@ -75087,7 +74781,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *487 + items: *485 examples: default: value: @@ -75122,10 +74816,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *318 - - *319 - - *479 - - &489 + - *314 + - *315 + - *477 + - &487 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75137,9 +74831,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: *488 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,10 +74854,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *479 - - *319 - - *318 - - *489 + - *477 + - *315 + - *314 + - *487 responses: '204': description: Response @@ -75189,9 +74883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *17 - *19 responses: @@ -75209,9 +74903,9 @@ paths: type: integer secrets: type: array - items: *363 + items: *359 examples: - default: *364 + default: *360 headers: Link: *56 x-github: @@ -75236,17 +74930,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 responses: '200': description: Response content: application/json: - schema: *365 + schema: *361 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75268,18 +74962,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 responses: '200': description: Response content: application/json: - schema: *363 + schema: *359 examples: - default: *490 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75301,9 +74995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 requestBody: required: true @@ -75361,9 +75055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 responses: '204': @@ -75389,10 +75083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *318 - - *319 - - *479 - - *334 + - *314 + - *315 + - *477 + - *330 - *19 responses: '200': @@ -75409,9 +75103,9 @@ paths: type: integer variables: type: array - items: *367 + items: *363 examples: - default: *368 + default: *364 headers: Link: *56 x-github: @@ -75434,9 +75128,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: true content: @@ -75488,18 +75182,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *155 responses: '200': description: Response content: application/json: - schema: *367 + schema: *363 examples: - default: *491 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75520,10 +75214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 - - *479 + - *477 requestBody: required: true content: @@ -75565,10 +75259,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 - - *479 + - *477 responses: '204': description: Response @@ -75590,8 +75284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -75659,8 +75353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *318 - - *319 + - *314 + - *315 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75819,8 +75513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -75853,9 +75547,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 '400': *14 '422': *15 '403': *27 @@ -75876,8 +75570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -75937,7 +75631,7 @@ paths: schema: oneOf: - *113 - - *492 + - *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75962,8 +75656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *318 - - *319 + - *314 + - *315 - name: file_sha in: path required: true @@ -76063,8 +75757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76173,7 +75867,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &491 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -76400,15 +76094,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 responses: '200': description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -76464,9 +76158,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *318 - - *319 - - &494 + - *314 + - *315 + - &492 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. @@ -76483,7 +76177,7 @@ paths: application/json: schema: type: array - items: &495 + items: &493 title: Git Reference description: Git references within a repository type: object @@ -76559,17 +76253,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 responses: '200': description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: &496 + default: &494 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -76598,8 +76292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76628,9 +76322,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: *496 + default: *494 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -76656,9 +76350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 requestBody: required: true content: @@ -76687,9 +76381,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: *496 + default: *494 '422': *15 '409': *49 x-github: @@ -76707,9 +76401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 responses: '204': description: Response @@ -76764,8 +76458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76832,7 +76526,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &496 title: Git Tag description: Metadata for a Git tag type: object @@ -76888,7 +76582,7 @@ paths: - sha - type - url - verification: *497 + verification: *495 required: - sha - url @@ -76898,7 +76592,7 @@ paths: - tag - message examples: - default: &499 + default: &497 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76971,8 +76665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *318 - - *319 + - *314 + - *315 - name: tag_sha in: path required: true @@ -76983,9 +76677,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *496 examples: - default: *499 + default: *497 '404': *6 '409': *49 x-github: @@ -77009,8 +76703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -77084,7 +76778,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &498 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -77186,8 +76880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *318 - - *319 + - *314 + - *315 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -77210,7 +76904,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *498 examples: default-response: summary: Default response @@ -77269,8 +76963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -77280,7 +76974,7 @@ paths: application/json: schema: type: array - items: &501 + items: &499 title: Webhook description: Webhooks for repositories. type: object @@ -77420,8 +77114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -77474,9 +77168,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: &502 + default: &500 value: type: Repository id: 12345678 @@ -77524,17 +77218,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '200': description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: *502 + default: *500 '404': *6 x-github: githubCloudOnly: false @@ -77554,8 +77248,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 requestBody: required: true @@ -77601,9 +77295,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: *502 + default: *500 '422': *15 '404': *6 x-github: @@ -77624,8 +77318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77650,8 +77344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '200': @@ -77679,8 +77373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *193 requestBody: required: false @@ -77725,8 +77419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *17 - *194 @@ -77758,8 +77452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *16 responses: @@ -77788,8 +77482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *16 responses: @@ -77813,8 +77507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77840,8 +77534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77865,8 +77559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response if immutable releases are enabled @@ -77914,8 +77608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '409': *49 @@ -77935,8 +77629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '409': *49 @@ -77993,14 +77687,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &503 + schema: &501 title: Import description: A repository import from an external source. type: object @@ -78107,7 +77801,7 @@ paths: - html_url - authors_url examples: - default: &506 + default: &504 value: vcs: subversion use_lfs: true @@ -78123,7 +77817,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': &504 + '503': &502 description: Unavailable due to service under maintenance. content: application/json: @@ -78152,8 +77846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -78201,7 +77895,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: default: value: @@ -78226,7 +77920,7 @@ paths: type: string '422': *15 '404': *6 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78254,8 +77948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -78307,7 +78001,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: example-1: summary: Example 1 @@ -78355,7 +78049,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': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78378,12 +78072,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78409,8 +78103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *318 - - *319 + - *314 + - *315 - &672 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -78425,7 +78119,7 @@ paths: application/json: schema: type: array - items: &505 + items: &503 title: Porter Author description: Porter Author type: object @@ -78479,7 +78173,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': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78504,8 +78198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *318 - - *319 + - *314 + - *315 - name: author_id in: path required: true @@ -78535,7 +78229,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *503 examples: default: value: @@ -78548,7 +78242,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78572,8 +78266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78614,7 +78308,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78642,8 +78336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -78670,11 +78364,11 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: - default: *506 + default: *504 '422': *15 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78697,8 +78391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78706,8 +78400,8 @@ paths: application/json: schema: *20 examples: - default: *507 - '301': *322 + default: *505 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -78727,8 +78421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78741,7 +78435,7 @@ paths: properties: {} additionalProperties: false examples: - default: &509 + default: &507 value: limit: collaborators_only origin: repository @@ -78766,13 +78460,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *508 + schema: *506 examples: default: summary: Example request body @@ -78786,7 +78480,7 @@ paths: application/json: schema: *211 examples: - default: *509 + default: *507 '409': description: Response x-github: @@ -78808,8 +78502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -78832,8 +78526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -78843,7 +78537,7 @@ paths: application/json: schema: type: array - items: *510 + items: *508 examples: default: &665 value: @@ -78976,8 +78670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *318 - - *319 + - *314 + - *315 - *215 requestBody: required: false @@ -79007,7 +78701,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *508 examples: default: value: @@ -79138,8 +78832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *318 - - *319 + - *314 + - *315 - *215 responses: '204': @@ -79171,8 +78865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *318 - - *319 + - *314 + - *315 - 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 @@ -79393,7 +79087,7 @@ paths: state_reason: completed headers: Link: *56 - '301': *322 + '301': *318 '422': *15 '404': *6 x-github: @@ -79422,8 +79116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -79671,7 +79365,7 @@ paths: '422': *15 '503': *105 '404': *6 - '410': *511 + '410': *509 x-github: triggersNotification: true githubCloudOnly: false @@ -79699,8 +79393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *93 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -79721,7 +79415,7 @@ paths: application/json: schema: type: array - items: *512 + items: *510 examples: default: &517 value: @@ -79781,17 +79475,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: &513 + default: &511 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79845,8 +79539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -79869,9 +79563,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -79889,8 +79583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -79911,8 +79605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79939,9 +79633,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -79962,8 +79656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -79996,16 +79690,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -80027,10 +79721,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - *513 responses: '204': description: Response @@ -80050,8 +79744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -80400,8 +80094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *318 - - *319 + - *314 + - *315 - name: event_id in: path required: true @@ -80604,7 +80298,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *511 + '410': *509 '403': *27 x-github: githubCloudOnly: false @@ -80638,8 +80332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - &516 name: issue_number description: The number that identifies the issue. @@ -80655,9 +80349,9 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '304': *35 x-github: githubCloudOnly: false @@ -80682,8 +80376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -80809,9 +80503,9 @@ paths: '422': *15 '503': *105 '403': *27 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80829,8 +80523,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -80875,8 +80569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: content: @@ -80926,8 +80620,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: - - *318 - - *319 + - *314 + - *315 - *516 - name: assignee in: path @@ -80968,8 +80662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *76 - *17 @@ -80981,13 +80675,13 @@ paths: application/json: schema: type: array - items: *512 + items: *510 examples: default: *517 headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81016,8 +80710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -81040,16 +80734,16 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -81077,8 +80771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -81094,9 +80788,9 @@ paths: default: *518 headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81124,8 +80818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -81156,9 +80850,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *322 + '301': *318 '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -81189,8 +80883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: issue_id in: path @@ -81206,12 +80900,12 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *511 + '410': *509 x-github: triggersNotification: true githubCloudOnly: false @@ -81237,8 +80931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -81254,9 +80948,9 @@ paths: default: *518 headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81273,8 +80967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82068,7 +81762,7 @@ paths: color: red headers: Link: *56 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82085,8 +81779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82117,9 +81811,9 @@ paths: default: false headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82136,8 +81830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82200,9 +81894,9 @@ paths: items: *69 examples: default: *519 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '422': *15 x-github: githubCloudOnly: false @@ -82219,8 +81913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82284,9 +81978,9 @@ paths: items: *69 examples: default: *519 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '422': *15 x-github: githubCloudOnly: false @@ -82303,15 +81997,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '204': description: Response - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82330,8 +82024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: name in: path @@ -82356,9 +82050,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82378,8 +82072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82409,7 +82103,7 @@ paths: '204': description: Response '403': *27 - '410': *511 + '410': *509 '404': *6 '422': *15 x-github: @@ -82427,8 +82121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '204': @@ -82459,8 +82153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '200': @@ -82470,9 +82164,9 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82489,8 +82183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -82517,13 +82211,13 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82541,8 +82235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82575,16 +82269,16 @@ paths: description: Response content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Response content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -82606,10 +82300,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *516 - - *316 + - *513 responses: '204': description: Response @@ -82638,8 +82332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82697,8 +82391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82715,7 +82409,7 @@ paths: headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82743,8 +82437,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82781,7 +82475,7 @@ paths: schema: type: string '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -82801,8 +82495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82858,8 +82552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -83454,7 +83148,7 @@ paths: type: string comments: type: array - items: *446 + items: *442 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -83729,7 +83423,7 @@ paths: headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83746,8 +83440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -83825,8 +83519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -83898,8 +83592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 - &535 name: key_id description: The unique identifier of the key. @@ -83932,8 +83626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 - *535 responses: '204': @@ -83954,8 +83648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -83988,8 +83682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84059,8 +83753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84090,8 +83784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84156,8 +83850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84183,8 +83877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -84223,9 +83917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *318 - - *319 - - *421 + - *314 + - *315 + - *417 responses: '200': description: Response @@ -84372,8 +84066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84438,8 +84132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84473,7 +84167,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *447 + schema: *445 examples: default: *537 '204': @@ -84500,8 +84194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *318 - - *319 + - *314 + - *315 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -84598,8 +84292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84700,8 +84394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - &539 name: milestone_number description: The number that identifies the milestone. @@ -84733,8 +84427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 requestBody: required: false @@ -84791,8 +84485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 responses: '204': @@ -84814,8 +84508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 - *17 - *19 @@ -84847,8 +84541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 - *540 - *541 - *76 @@ -84888,8 +84582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -84947,8 +84641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -85139,8 +84833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85220,8 +84914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85321,8 +85015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -85348,8 +85042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -85451,8 +85145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -85499,8 +85193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -85556,8 +85250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *318 - - *319 + - *314 + - *315 - name: build_id in: path required: true @@ -85590,8 +85284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85699,8 +85393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 - &548 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -85759,8 +85453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 - *548 responses: '204': *176 @@ -85788,8 +85482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -86084,8 +85778,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Private vulnerability reporting status @@ -86122,8 +85816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '422': *14 @@ -86144,8 +85838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '422': *14 @@ -86167,8 +85861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -86200,8 +85894,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -86255,8 +85949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *318 - - *319 + - *314 + - *315 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -86316,7 +86010,7 @@ paths: application/json: schema: type: array - items: *451 + items: *449 examples: default: *551 headers: @@ -86350,8 +86044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -87287,8 +86981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: sort in: query required: false @@ -87396,8 +87090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': @@ -87481,8 +87175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -87523,8 +87217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -87546,8 +87240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87574,9 +87268,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -87597,8 +87291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -87631,16 +87325,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -87662,10 +87356,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - *513 responses: '204': description: Response @@ -87708,8 +87402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - &557 name: pull_number description: The number that identifies the pull request. @@ -87760,8 +87454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -87828,8 +87522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -87893,7 +87587,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -87901,7 +87595,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -87931,8 +87625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *93 - name: direction @@ -87989,8 +87683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -88185,8 +87879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *85 requestBody: @@ -88296,8 +87990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -88308,7 +88002,7 @@ paths: application/json: schema: type: array - items: *447 + items: *445 examples: default: *559 headers: @@ -88340,8 +88034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -88352,7 +88046,7 @@ paths: application/json: schema: type: array - items: *458 + items: *456 examples: default: value: @@ -88390,8 +88084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *318 - - *319 + - *314 + - *315 - *557 responses: '204': @@ -88415,8 +88109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -88529,8 +88223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 responses: '200': @@ -88606,8 +88300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -88645,7 +88339,7 @@ paths: description: Response content: application/json: - schema: *451 + schema: *449 examples: default: value: @@ -89181,8 +88875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -89217,7 +88911,7 @@ paths: description: Response content: application/json: - schema: *451 + schema: *449 examples: default: value: @@ -89722,8 +89416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -89890,8 +89584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -90047,8 +89741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - &561 name: review_id @@ -90123,8 +89817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90211,8 +89905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 responses: @@ -90249,8 +89943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 - *17 @@ -90510,8 +90204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90605,8 +90299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90667,8 +90361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -90733,8 +90427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *318 - - *319 + - *314 + - *315 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -90791,8 +90485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *318 - - *319 + - *314 + - *315 - name: dir description: The alternate path to look for a README file in: path @@ -90836,8 +90530,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -90941,8 +90635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -91125,8 +90819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - &568 name: asset_id description: The unique identifier of the asset. @@ -91176,7 +90870,7 @@ paths: type: User site_admin: false '404': *6 - '302': *460 + '302': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91192,8 +90886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - *568 requestBody: required: false @@ -91241,8 +90935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - *568 responses: '204': @@ -91267,8 +90961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -91354,8 +91048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -91380,8 +91074,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *318 - - *319 + - *314 + - *315 - name: tag description: tag parameter in: path @@ -91418,8 +91112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *318 - - *319 + - *314 + - *315 - &571 name: release_id description: The unique identifier of the release. @@ -91454,8 +91148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 requestBody: required: false @@ -91543,8 +91237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 responses: '204': @@ -91565,8 +91259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *318 - - *319 + - *314 + - *315 - *571 - *17 - *19 @@ -91658,8 +91352,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: - - *318 - - *319 + - *314 + - *315 - *571 - name: name in: query @@ -91741,8 +91435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -91767,9 +91461,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -91790,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 requestBody: required: true @@ -91822,16 +91516,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -91853,10 +91547,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *571 - - *316 + - *513 responses: '204': description: Response @@ -91880,9 +91574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 - *17 - *19 responses: @@ -92019,8 +91713,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - name: includes_parents @@ -92086,8 +91780,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 requestBody: description: Request body required: true @@ -92196,8 +91890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *318 - - *319 + - *314 + - *315 - *576 - *577 - *578 @@ -92232,8 +91926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *318 - - *319 + - *314 + - *315 - *582 responses: '200': @@ -92270,8 +91964,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92311,8 +92005,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92394,8 +92088,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92418,8 +92112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - name: ruleset_id @@ -92456,8 +92150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92530,8 +92224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *588 - *589 - *590 @@ -92809,9 +92503,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *598 responses: '200': @@ -92872,9 +92566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: true content: @@ -93014,9 +92708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *19 - *17 responses: @@ -93152,8 +92846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -93232,8 +92926,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: - - *318 - - *319 + - *314 + - *315 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -93354,8 +93048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *318 - - *319 + - *314 + - *315 - *50 - name: sort description: The property to sort the results by. @@ -93424,8 +93118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -93830,8 +93524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -94091,8 +93785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 - *621 responses: '200': @@ -94125,8 +93819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 - *621 requestBody: required: true @@ -94339,8 +94033,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: - - *318 - - *319 + - *314 + - *315 - *621 responses: '202': *37 @@ -94368,17 +94062,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *318 - - *319 + - *314 + - *315 - *621 responses: '202': description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 '400': *14 '422': *15 '403': *27 @@ -94404,8 +94098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -94501,8 +94195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -94544,8 +94238,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -94623,8 +94317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -94718,8 +94412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -94873,8 +94567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -94917,8 +94611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *318 - - *319 + - *314 + - *315 - name: sha in: path required: true @@ -95028,8 +94722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95061,8 +94755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: if you subscribe to the repository @@ -95141,8 +94835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -95195,8 +94889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -95216,8 +94910,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95299,8 +94993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95365,8 +95059,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -95420,8 +95114,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: - - *318 - - *319 + - *314 + - *315 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -95458,8 +95152,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *318 - - *319 + - *314 + - *315 - name: ref in: path required: true @@ -95495,8 +95189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95528,8 +95222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 responses: @@ -95572,8 +95266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -95627,8 +95321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *318 - - *319 + - *314 + - *315 - &629 name: per description: The time frame to display results for. @@ -95748,8 +95442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95844,8 +95538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95909,8 +95603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *318 - - *319 + - *314 + - *315 - *629 responses: '200': @@ -96010,8 +95704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -96285,8 +95979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -96309,8 +96003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -96332,8 +96026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -96359,8 +96053,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *318 - - *319 + - *314 + - *315 - name: ref in: path required: true @@ -96452,9 +96146,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -96935,7 +96629,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 comment_count: type: integer message: @@ -96954,7 +96648,7 @@ paths: url: type: string format: uri - verification: *497 + verification: *495 required: - author - committer @@ -96969,7 +96663,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 parents: type: array items: @@ -99178,246 +98872,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: - - *636 - - *309 - - *312 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *636 - - *309 - - *312 - 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: *313 - examples: - default: *314 - 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: - - *636 - - *309 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *636 - - *309 - 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: *313 - examples: - default: *314 - 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) @@ -99643,7 +99097,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-user-is-a-team-maintainer: *641 '404': *6 @@ -99704,7 +99158,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-users-membership-with-team-is-now-pending: *642 '403': @@ -99811,8 +99265,8 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Alternative response with extra repository information @@ -99970,8 +99424,8 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -100022,8 +99476,8 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -100849,7 +100303,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -100857,7 +100311,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -100943,7 +100397,7 @@ paths: - visibility - selected_repositories_url examples: - default: *440 + default: *436 headers: Link: *56 x-github: @@ -101319,7 +100773,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '304': *35 '500': *104 '401': *23 @@ -101377,7 +100831,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -101571,7 +101025,7 @@ paths: type: integer machines: type: array - items: *439 + items: *435 examples: default: *651 '304': *35 @@ -101658,11 +101112,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *321 + repository: *317 machine: anyOf: - type: 'null' - - *439 + - *435 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -102467,7 +101921,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '304': *35 '500': *104 '400': *14 @@ -102507,7 +101961,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '500': *104 '401': *23 '403': *27 @@ -103678,7 +103132,7 @@ paths: required: true content: application/json: - schema: *508 + schema: *506 examples: default: value: @@ -106143,9 +105597,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106183,7 +105637,7 @@ paths: application/json: schema: type: array - items: *510 + items: *508 examples: default: *665 headers: @@ -106802,8 +106256,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: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response if this repository is starred by you @@ -106831,8 +106285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -106856,8 +106310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -107538,7 +106992,7 @@ paths: initiator: type: string examples: - default: *379 + default: *375 '201': description: Response content: @@ -108069,7 +107523,7 @@ paths: application/json: schema: *20 examples: - default: *507 + default: *505 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115568,7 +115022,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115900,7 +115354,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -116244,7 +115698,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116603,7 +116057,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -116886,7 +116340,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117184,7 +116638,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117505,7 +116959,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118617,7 +118071,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118705,7 +118159,7 @@ webhooks: type: string enum: - auto_reopened - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118793,7 +118247,7 @@ webhooks: type: string enum: - created - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118879,7 +118333,7 @@ webhooks: type: string enum: - dismissed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118965,7 +118419,7 @@ webhooks: type: string enum: - fixed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -119052,7 +118506,7 @@ webhooks: type: string enum: - reintroduced - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -119138,7 +118592,7 @@ webhooks: type: string enum: - reopened - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -120656,7 +120110,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *472 + deployment: *470 pull_requests: type: array items: *555 @@ -151078,7 +150532,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *399 + head_commit: *395 required: - head_sha - head_ref @@ -225248,7 +224702,7 @@ webhooks: enterprise: *699 installation: *700 organization: *701 - repository: *321 + repository: *317 sender: *4 required: - changes @@ -230578,7 +230032,7 @@ webhooks: type: string required: - conclusion - deployment: *472 + deployment: *470 required: - action - repository @@ -230942,7 +230396,7 @@ webhooks: required: - status - steps - deployment: *472 + deployment: *470 required: - action - repository @@ -231170,7 +230624,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *472 + deployment: *470 required: - action - repository @@ -231399,7 +230853,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *472 + deployment: *470 required: - action - repository diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 11a00aeb0..22acab592 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -232253,17 +232253,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": [ { @@ -232285,40 +232285,376 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "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": "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": "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" } }, { @@ -232348,12 +232684,31 @@ "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -232361,215 +232716,139 @@ "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDQ6VXNlcjE=" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "gravatar_id": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "41d064eb2195891e12d0413f63227ea7" ] }, - "created_at": { + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "user", - "content", - "created_at" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } }, @@ -232577,30 +232856,24 @@ "default": { "value": [ { + "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 } ] } @@ -232620,20 +232893,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}/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": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/get-membership-for-user-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#get-team-membership-for-a-user" }, "parameters": [ { @@ -232655,54 +232930,143 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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": "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": { - "content": { + "role": { "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The role that this user should have in the team.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "member", + "maintainer" + ], + "default": "member" } - }, - "required": [ - "content" - ] + } }, "examples": { "default": { + "summary": "Add or update team membership for an organization member", "value": { - "content": "heart" + "role": "maintainer" } } } @@ -232711,549 +233075,82 @@ }, "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": "Team Membership", + "description": "Team Membership", "type": "object", "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] + "url": { + "type": "string", + "format": "uri" }, - "node_id": { + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "member" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", + "state": { + "description": "The state of the user's membership in the team.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "active", + "pending" ] } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "role", + "state", + "url" ] }, "examples": { - "default": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", "value": { - "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": "member", + "state": "pending" } } } } } }, - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - } - } - } - } + "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": "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.", + "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": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "teams/remove-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#remove-team-membership-for-a-user" }, "parameters": [ { @@ -233275,57 +233172,42 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": [ { @@ -233346,34 +233228,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).\"", @@ -233401,381 +233255,1187 @@ "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", + "format": "int64", "examples": [ - 1 + 1296269 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/repos/octocat/Hello-World" ] - } - }, - "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" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": 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": { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "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.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "owner": { "anyOf": [ { "type": "null" @@ -233950,307 +234610,606 @@ } ] }, - "content": { - "description": "The reaction to use", + "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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-05-20T20:09:31Z" + "https://api.github.com/repos/octocat/Hello-World" ] - } - }, - "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", + }, + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "content": { - "description": "The reaction to use", + "branches_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" ], + "format": "uri", "examples": [ - "heart" + "git:git.example.com/octocat/Hello-World" ] }, - "created_at": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + 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", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + 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", - "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", + "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": { - "default": { + "alternative-response-with-repository-permissions": { "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=", @@ -234270,34 +235229,220 @@ "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, + "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": false, - "category": "reactions", - "subcategory": "reactions" + "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": [ { @@ -234319,21 +235464,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" } } ], @@ -234345,22 +235490,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": [ { @@ -234402,575 +235547,298 @@ ], "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", - "null" - ] + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": [ "string", "null" ] }, - "failed_reason": { - "type": [ - "string", - "null" - ] + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "type": "boolean" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/members": { - "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "tags": [ - "teams" - ], - "operationId": "teams/list-members-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "members_url": { + "type": "string" }, - "events_url": { + "repositories_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "type": { + "description": "The ownership type of the team", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "enterprise", + "organization" ] }, - "type": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "User" + 37 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 42 ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } ] } }, "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", + "parent", + "type" ] } }, "examples": { - "default": { + "response-if-child-teams-exist": { "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 + "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" } ] } @@ -234991,126 +235859,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "members" + "subcategory": "teams" } } }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - } - } - } - } - }, - "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "/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/add-or-update-membership-for-user-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#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -235123,21 +235886,34 @@ } }, { - "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": "username", - "description": "The handle for the GitHub user account.", + "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" + ] } } ], @@ -235146,1197 +235922,524 @@ "content": { "application/json": { "schema": { - "type": "object", "properties": { - "role": { + "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", - "description": "The role that this user should have in the team.", "enum": [ - "member", - "maintainer" - ], - "default": "member" + "default", + "extended" + ] } } }, "examples": { "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" - } + "value": null } } } } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] - }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" + "204": { + "description": "Action started" }, "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" + "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" - } - }, - "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" - } + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } + "deprecated": true } }, - "/orgs/{org}/teams/{team_slug}/repos": { + "/rate_limit": { "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 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/list-repos-in-org", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + "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": "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 - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "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" - ] - } + "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" } }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } + "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" } - } - } - }, - "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" - ] - } + }, + "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": [ - { - "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 + "value": { + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 }, - "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 + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "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": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "type": "string" + "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" + } + } } } } @@ -236345,42 +236448,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "/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}`.", + "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/check-permissions-for-repo-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/rest/repos/repos#get-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.", @@ -236402,19 +236487,19 @@ ], "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": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", "type": "integer", + "format": "int64", "examples": [ - 42 + 1296269 ] }, "node_id": { @@ -236424,10 +236509,9 @@ ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Hello-World" ] }, "full_name": { @@ -236436,280 +236520,175 @@ "octocat/Hello-World" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "admin": { - "type": "boolean" + "name": { + "type": [ + "string", + "null" + ] }, - "pull": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "triage": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "push": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "maintain": { + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -237037,13 +237016,13 @@ ] }, "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", "examples": [ 108 ] }, "default_branch": { - "description": "The default branch of the repository.", "type": "string", "examples": [ "master" @@ -237056,8 +237035,6 @@ ] }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, "type": "boolean", "examples": [ true @@ -237067,27 +237044,27 @@ "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, "type": "boolean", "examples": [ true @@ -237097,16 +237074,18 @@ "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { "type": "boolean", "examples": [ true ] }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { @@ -237115,2134 +237094,58 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" + "type": "string", + "examples": [ + "public" + ] }, "pushed_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - 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, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "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/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", - "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" - ] - }, - "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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - 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", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { + "allow_rebase_merge": { "type": "boolean", "examples": [ true @@ -618053,1170 +615956,56 @@ "https://api.github.com/users/octocat/received_events" ] }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "fragment": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "draft": { - "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" + ] + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -619383,784 +616172,461 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { "type": "integer" }, - "watchers": { + "completed": { "type": "integer" }, - "master_branch": { - "type": "string" + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "blocking": { + "type": "integer" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "total_blocked_by": { + "type": "integer" }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "total_blocking": { + "type": "integer" } }, "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" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] }, - "body_html": { - "type": "string" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } }, - "body_text": { + "state": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "state_reason": { "type": [ - "object", + "string", "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } - }, - "required": [ - "id", - "node_id", - "name", - "description" ] }, - "performed_via_github_app": { + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 37 + 1002604 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "node_id": { + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "open" ] }, - "client_id": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "v1.0" ] }, - "owner": { - "oneOf": [ + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -620304,680 +616770,118 @@ "user_view_type": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 280, - "incomplete_results": false, - "items": [ - { - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", - "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", - "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", - "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", - "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", - "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", - "id": 35802, - "node_id": "MDU6SXNzdWUzNTgwMg==", - "number": 132, - "title": "Line Number Indexes Beyond 20 Not Displayed", - "user": { - "login": "Nick3C", - "id": 90254, - "node_id": "MDQ6VXNlcjkwMjU0", - "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/Nick3C", - "html_url": "https://github.com/Nick3C", - "followers_url": "https://api.github.com/users/Nick3C/followers", - "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", - "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", - "organizations_url": "https://api.github.com/users/Nick3C/orgs", - "repos_url": "https://api.github.com/users/Nick3C/repos", - "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", - "received_events_url": "https://api.github.com/users/Nick3C/received_events", - "type": "User", - "site_admin": true - }, - "labels": [ - { - "id": 4, - "node_id": "MDU6TGFiZWw0", - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", - "name": "bug", - "color": "ff0000" - } - ], - "state": "open", - "assignee": null, - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "comments": 15, - "created_at": "2009-07-12T20:10:41Z", - "updated_at": "2009-07-19T09:23:43Z", - "closed_at": null, - "pull_request": { - "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "body": "...", - "score": 1, - "locked": true, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ] - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/labels": { - "get": { - "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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 find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/labels", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-labels" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "query", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. 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": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ] - } - }, - { - "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": "Label Search Result Item", - "description": "Label Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" + "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" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "node_id": { - "type": "string" + "comments": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" + "format": "date-time" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "date-time" }, - "description": { + "closed_at": { "type": [ "string", "null" - ] - }, - "score": { - "type": "number" + ], + "format": "date-time" }, "text_matches": { "title": "Search Result Text Matches", @@ -621019,308 +616923,203 @@ } } } - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "incomplete_results": false, - "items": [ - { - "id": 418327088, - "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", - "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", - "name": "enhancement", - "color": "84b6eb", - "default": true, - "description": "New feature or request.", - "score": 1 - }, - { - "id": 418327086, - "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", - "url": "https://api.github.com/repos/octocat/linguist/labels/bug", - "name": "bug", - "color": "ee0701", - "default": true, - "description": "Something isn't working.", - "score": 1 - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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": [ - { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - { + "diff_url": { "type": [ - "integer", + "string", "null" - ] + ], + "format": "uri" }, - { + "html_url": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/repositories": { - "get": { - "summary": "Search repositories", - "description": "Find repositories 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 repositories, you can get text match metadata for the **name** and **description** fields 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 popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/search/search#search-repositories" - }, - "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 for repositories](https://docs.github.com/articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "stars", - "forks", - "help-wanted-issues", - "updated" - ] - } - }, - { - "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": "Repo Search Result Item", - "description": "Repo Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { + "body": { "type": "string" }, - "name": { - "type": "string" + "score": { + "type": "number" }, - "full_name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -621487,966 +617286,1223 @@ "type", "url" ] - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "score": { - "type": "number" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "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" - }, - "license": { - "anyOf": [ - { - "type": "null" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "maintain": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "push": { - "type": "boolean" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "triage": { - "type": "boolean" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 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", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "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", - "examples": [ - 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": [ - { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + 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", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - { + "created_at": { "type": [ - "integer", + "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - { + "updated_at": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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", - "null" - ] - }, - "short_description": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_by": { - "type": [ - "string", - "null" + }, + "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" ] }, - "released": { - "type": [ - "string", - "null" - ] + "body_html": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "body_text": { + "type": "string" }, - "updated_at": { + "timeline_url": { "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" + "format": "uri" }, - "repository_count": { + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "integer", + "object", "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { + "issues": { "type": "string" }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } - } - } - } - } - } - }, - "related": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "name": { + "additionalProperties": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } - } - } - } - } - }, - "aliases": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] } - } + ] + }, + "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": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", "updated_at", - "featured", - "curated", "score" ] } @@ -622456,436 +618512,103 @@ "examples": { "default": { "value": { - "total_count": 6, + "total_count": 280, "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", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "score": { - "type": "number" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, - "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", + "body": "...", "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 + "locked": true, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -622894,9 +618617,6 @@ } } }, - "304": { - "description": "Not modified" - }, "503": { "description": "Service unavailable", "content": { @@ -622992,6 +618712,35 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { @@ -623002,27 +618751,81 @@ } } }, - "/teams/{team_id}": { + "/search/labels": { "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.", + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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 find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/get-legacy", + "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/rest/search/search#search-labels" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", "required": true, "schema": { "type": "integer" } + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. 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": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + } + }, + { + "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": { @@ -623031,753 +618834,146 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "node_id": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "score": { + "type": "number" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + } } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -623803,1794 +618999,1821 @@ } } } - } - }, - "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", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] + "type": "string" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "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" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "documentation_url": { + "type": "string" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "field": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories 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 repositories, you can get text match metadata for the **name** and **description** fields 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 popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-repositories" + }, + "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 for repositories](https://docs.github.com/articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + } + }, + { + "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": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "pushed_at": { + "type": "string", + "format": "date-time" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "score": { + "type": "number" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "topics": { + "type": "array", + "items": { "type": "string" + } + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "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" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "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": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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", + "examples": [ + false + ] + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] + "required": [ + "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": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { + } + } + } + } + } + }, + "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" }, - "status": { + "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "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", + "null" + ] + }, + "short_description": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "created_by": { + "type": [ + "string", + "null" + ] + }, + "released": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + "logo_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "related": { + "type": [ + "array", + "null" + ], + "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", + "null" + ], + "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": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "incomplete_results", + "items" ], "properties": { - "message": { - "type": "string" + "total_count": { + "type": "integer" }, - "documentation_url": { - "type": "string" + "incomplete_results": { + "type": "boolean" }, - "errors": { + "items": { "type": "array", "items": { + "title": "User Search Result Item", + "description": "User Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "login": { "type": "string" }, - "field": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string" }, - "message": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, - "code": { + "score": { + "type": "number" + }, + "following_url": { "type": "string" }, - "index": { + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "public_repos": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "site_admin": { + "type": "boolean" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } + } + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -625677,25 +620900,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true + "category": "search", + "subcategory": "search" + } } }, - "/teams/{team_id}/discussions": { + "/teams/{team_id}": { "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "Get a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -625706,38 +620926,6 @@ "schema": { "type": "integer" } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/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": { @@ -625746,545 +620934,115 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/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": [ { @@ -626699,548 +621738,941 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + 1 + ] + }, + "node_id": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/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": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -627248,378 +622680,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" + "enum": [ + "enterprise", + "organization" + ] }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -627950,11 +623850,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -627964,45 +623877,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628060,12 +623994,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" ] @@ -628095,19 +624034,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, @@ -628140,20 +624084,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": [ { @@ -628164,15 +624108,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -628182,19 +624117,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." } } } @@ -628207,8 +624153,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": { @@ -628387,16 +624333,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -628406,11 +624352,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -628420,45 +624379,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628516,12 +624496,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" ] @@ -628549,19 +624534,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, @@ -628586,22 +624576,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": [ { @@ -628621,15 +624611,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -628638,8 +624619,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": { @@ -628818,16 +624799,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -628837,11 +624818,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -628851,45 +624845,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -628947,12 +624962,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" ] @@ -628980,19 +625000,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, @@ -629016,20 +625041,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": [ { @@ -629049,37 +625074,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" } } } @@ -629092,8 +625109,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": { @@ -629272,16 +625289,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -629291,11 +625308,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -629305,45 +625335,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -629401,12 +625452,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" ] @@ -629434,19 +625490,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, @@ -629470,20 +625531,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": [ { @@ -629503,15 +625564,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -629525,22 +625577,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": [ { @@ -629562,31 +625614,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" } }, { @@ -629616,23 +625654,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -629807,104 +625833,678 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" + "eyes", + "rocket" ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + } + } + } + }, + "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": "discussion-comments" + }, + "deprecated": true + }, + "post": { + "summary": "Create a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/create-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy" + }, + "parameters": [ + { + "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": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like apples?" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "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": { + "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 - }, - "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.", + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/get-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#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -629935,65 +626535,17 @@ } } ], - "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": { + "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -630168,45 +626720,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -630226,8 +626883,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 + } } } } @@ -630238,25 +626916,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 - } - }, - "/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.", + }, + "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/list-for-team-discussion-legacy", + "operationId": "teams/update-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#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -630278,354 +626954,8 @@ } }, { - "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", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - ] - } - } - } - }, - "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" - }, - "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": [ - { - "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.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -630640,29 +626970,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?" } } } @@ -630670,28 +626990,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -630866,45 +627174,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -630924,8 +627337,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 + } } } } @@ -630935,11 +627369,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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index de4cff6a1..831f26f6e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -9169,7 +9169,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &462 + - &460 name: has in: query description: |- @@ -9289,7 +9289,7 @@ paths: - direct - transitive - - security_advisory: &463 + security_advisory: &461 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9557,7 +9557,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &464 + auto_dismissed_at: &462 type: - string - 'null' @@ -9565,7 +9565,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &465 + dismissal_request: &463 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -11895,7 +11895,7 @@ paths: action: type: string issue: *70 - comment: &512 + comment: &510 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -16660,14 +16660,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &318 + - &314 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &319 + - &315 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16729,7 +16729,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &322 + '301': &318 description: Moved permanently content: application/json: @@ -20201,7 +20201,7 @@ paths: type: integer repository_cache_usages: type: array - items: &329 + items: &325 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21439,7 +21439,7 @@ paths: - all - local_only - selected - selected_actions_url: &335 + selected_actions_url: &331 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -21522,7 +21522,7 @@ paths: description: Response content: application/json: - schema: &339 + schema: &335 type: object properties: days: @@ -21564,7 +21564,7 @@ paths: required: true content: application/json: - schema: &340 + schema: &336 type: object properties: days: @@ -21621,7 +21621,7 @@ paths: required: - approval_policy examples: - default: &341 + default: &337 value: approval_policy: first_time_contributors '404': *6 @@ -21680,7 +21680,7 @@ paths: description: Response content: application/json: - schema: &342 + schema: &338 type: object required: - run_workflows_from_fork_pull_requests @@ -21734,7 +21734,7 @@ paths: required: true content: application/json: - schema: &343 + schema: &339 type: object required: - run_workflows_from_fork_pull_requests @@ -22369,7 +22369,7 @@ paths: description: Response content: application/json: - schema: &344 + schema: &340 type: object properties: default_workflow_permissions: &137 @@ -22420,7 +22420,7 @@ paths: required: false content: application/json: - schema: &345 + schema: &341 type: object properties: default_workflow_permissions: *137 @@ -23560,7 +23560,7 @@ paths: application/json: schema: type: array - items: &346 + items: &342 title: Runner Application description: Runner Application type: object @@ -23585,7 +23585,7 @@ paths: - download_url - filename examples: - default: &347 + default: &343 value: - os: osx architecture: x64 @@ -23671,7 +23671,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &348 + '201': &344 description: Response content: application/json: @@ -23786,7 +23786,7 @@ paths: - token - expires_at examples: - default: &349 + default: &345 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23825,7 +23825,7 @@ paths: application/json: schema: *148 examples: - default: &350 + default: &346 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23859,7 +23859,7 @@ paths: application/json: schema: *146 examples: - default: &351 + default: &347 value: id: 23 name: MBP @@ -24085,7 +24085,7 @@ paths: - *65 - *145 responses: - '200': &352 + '200': &348 description: Response content: application/json: @@ -24142,7 +24142,7 @@ paths: parameters: - *65 - *145 - - &353 + - &349 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24274,7 +24274,7 @@ paths: description: Response content: application/json: - schema: &365 + schema: &361 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24309,7 +24309,7 @@ paths: - key_id - key examples: - default: &366 + default: &362 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24722,7 +24722,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *65 - - &334 + - &330 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)." @@ -26290,7 +26290,7 @@ paths: initiator: type: string examples: - default: &379 + default: &375 value: attestations: - bundle: @@ -27246,7 +27246,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *65 - - &403 + - &399 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`, @@ -27256,7 +27256,7 @@ paths: schema: &169 type: string description: The name of the tool used to generate the code scanning analysis. - - &404 + - &400 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 @@ -27280,7 +27280,7 @@ paths: be returned. in: query required: false - schema: &406 + schema: &402 type: string description: State of a code scanning alert. enum: @@ -27303,7 +27303,7 @@ paths: be returned. in: query required: false - schema: &407 + schema: &403 type: string description: Severity of a code scanning alert. enum: @@ -27337,7 +27337,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: &408 + instances_url: &404 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -27359,7 +27359,7 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: &409 + dismissed_reason: &405 type: - string - 'null' @@ -27370,14 +27370,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &410 + dismissed_comment: &406 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &411 + rule: &407 type: object properties: id: @@ -27438,7 +27438,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &412 + tool: &408 type: object properties: name: *169 @@ -27449,26 +27449,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *170 - most_recent_instance: &413 + most_recent_instance: &409 type: object properties: - ref: &405 + ref: &401 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &423 + analysis_key: &419 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: &424 + environment: &420 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: &425 + category: &421 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -27482,7 +27482,7 @@ paths: properties: text: type: string - location: &426 + location: &422 type: object description: Describe a region within a file for the alert. properties: @@ -27503,7 +27503,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: &427 + items: &423 type: - string - 'null' @@ -28796,7 +28796,7 @@ paths: machine: anyOf: - type: 'null' - - &439 + - &435 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -29748,7 +29748,7 @@ paths: - updated_at - visibility examples: - default: &440 + default: &436 value: total_count: 2 secrets: @@ -29786,7 +29786,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &437 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29821,7 +29821,7 @@ paths: - key_id - key examples: - default: &442 + default: &438 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29853,7 +29853,7 @@ paths: application/json: schema: *179 examples: - default: &444 + default: &440 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -31476,7 +31476,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &466 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -31495,7 +31495,7 @@ paths: - key_id - key examples: - default: &469 + default: &467 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33323,7 +33323,7 @@ paths: application/json: schema: *20 examples: - default: &507 + default: &505 value: id: 1 account: @@ -33551,7 +33551,7 @@ paths: required: true content: application/json: - schema: &508 + schema: &506 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -34411,7 +34411,7 @@ paths: application/json: schema: *221 examples: - default: &438 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -38873,7 +38873,7 @@ paths: content: oneOf: - *70 - - &451 + - &449 title: Pull Request Simple description: Pull Request Simple type: object @@ -41945,7 +41945,7 @@ paths: description: Response content: application/json: - schema: &321 + schema: &317 title: Full Repository description: Full Repository type: object @@ -42410,7 +42410,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &456 + code_of_conduct: &454 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -42524,7 +42524,7 @@ paths: - network_count - subscribers_count examples: - default: &323 + default: &319 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49041,408 +49041,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: - - *65 - - *66 - - *309 - - *312 - - 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: &313 - 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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - *4 - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &315 - 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: *56 - 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: - - *65 - - *66 - - *309 - - *312 - 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: *313 - examples: - default: &314 - 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: *313 - examples: - default: *314 - 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: - - *65 - - *66 - - *309 - - *312 - - &316 - 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: - - *65 - - *66 - - *309 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *65 - - *66 - - *309 - 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: *313 - examples: - default: *314 - '201': - description: Response - content: - application/json: - schema: *313 - examples: - default: *314 - 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: - - *65 - - *66 - - *309 - - *316 - 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 @@ -49555,7 +49153,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &313 title: Team Membership description: Team Membership type: object @@ -49646,7 +49244,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-users-membership-with-team-is-now-pending: &642 summary: Response if user's membership with team is now pending @@ -49755,8 +49353,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Alternative response with repository permissions @@ -50405,8 +50003,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -50453,8 +50051,8 @@ paths: parameters: - *65 - *66 - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -50645,7 +50243,7 @@ paths: resources: type: object properties: - core: &320 + core: &316 title: Rate Limit type: object properties: @@ -50662,21 +50260,21 @@ paths: - remaining - reset - used - graphql: *320 - search: *320 - code_search: *320 - source_import: *320 - integration_manifest: *320 - code_scanning_upload: *320 - actions_runner_registration: *320 - scim: *320 - dependency_snapshots: *320 - dependency_sbom: *320 - code_scanning_autofix: *320 + graphql: *316 + search: *316 + code_search: *316 + source_import: *316 + integration_manifest: *316 + code_scanning_upload: *316 + actions_runner_registration: *316 + scim: *316 + dependency_snapshots: *316 + dependency_sbom: *316 + code_scanning_autofix: *316 required: - core - search - rate: *320 + rate: *316 required: - rate - resources @@ -50781,14 +50379,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *321 + schema: *317 examples: default-response: summary: Default response @@ -51289,7 +50887,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *322 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51307,8 +50905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -51556,10 +51154,10 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 - '307': &324 + default: *319 + '307': &320 description: Temporary Redirect content: application/json: @@ -51588,8 +51186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -51611,7 +51209,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *324 + '307': *320 '404': *6 '409': *49 x-github: @@ -51635,11 +51233,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - - &357 + - &353 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51662,7 +51260,7 @@ paths: type: integer artifacts: type: array - items: &325 + items: &321 title: Artifact description: An artifact type: object @@ -51757,7 +51355,7 @@ paths: - expires_at - updated_at examples: - default: &358 + default: &354 value: total_count: 2 artifacts: @@ -51818,9 +51416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *318 - - *319 - - &326 + - *314 + - *315 + - &322 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51832,7 +51430,7 @@ paths: description: Response content: application/json: - schema: *325 + schema: *321 examples: default: value: @@ -51870,9 +51468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *318 - - *319 - - *326 + - *314 + - *315 + - *322 responses: '204': description: Response @@ -51896,9 +51494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *318 - - *319 - - *326 + - *314 + - *315 + - *322 - name: archive_format in: path required: true @@ -51912,7 +51510,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': &511 + '410': &509 description: Gone content: application/json: @@ -51937,14 +51535,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &327 + schema: &323 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51978,13 +51576,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *327 + schema: *323 examples: selected_actions: *40 responses: @@ -52013,14 +51611,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &328 + schema: &324 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52054,13 +51652,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *328 + schema: *324 examples: selected_actions: *42 responses: @@ -52091,14 +51689,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *329 + schema: *325 examples: default: value: @@ -52124,11 +51722,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - - &330 + - &326 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 @@ -52162,7 +51760,7 @@ paths: description: Response content: application/json: - schema: &331 + schema: &327 title: Repository actions caches description: Repository actions caches type: object @@ -52212,7 +51810,7 @@ paths: - total_count - actions_caches examples: - default: &332 + default: &328 value: total_count: 1 actions_caches: @@ -52244,23 +51842,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: - - *318 - - *319 + - *314 + - *315 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *330 + - *326 responses: '200': description: Response content: application/json: - schema: *331 + schema: *327 examples: - default: *332 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52280,8 +51878,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: - - *318 - - *319 + - *314 + - *315 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52312,9 +51910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *318 - - *319 - - &333 + - *314 + - *315 + - &329 name: job_id description: The unique identifier of the job. in: path @@ -52326,7 +51924,7 @@ paths: description: Response content: application/json: - schema: &361 + schema: &357 title: Job description: Information of a job execution in a workflow run type: object @@ -52673,9 +52271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *318 - - *319 - - *333 + - *314 + - *315 + - *329 responses: '302': description: Response @@ -52703,9 +52301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *318 - - *319 - - *333 + - *314 + - *315 + - *329 requestBody: required: false content: @@ -52751,8 +52349,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Status response @@ -52802,8 +52400,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -52866,8 +52464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -52885,7 +52483,7 @@ paths: type: integer secrets: type: array - items: &363 + items: &359 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -52906,7 +52504,7 @@ paths: - created_at - updated_at examples: - default: &364 + default: &360 value: total_count: 2 secrets: @@ -52939,9 +52537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *318 - - *319 - - *334 + - *314 + - *315 + - *330 - *19 responses: '200': @@ -52958,7 +52556,7 @@ paths: type: integer variables: type: array - items: &367 + items: &363 title: Actions Variable type: object properties: @@ -52992,7 +52590,7 @@ paths: - created_at - updated_at examples: - default: &368 + default: &364 value: total_count: 2 variables: @@ -53025,8 +52623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53035,11 +52633,11 @@ paths: schema: type: object properties: - enabled: &336 + enabled: &332 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *129 - selected_actions_url: *335 + selected_actions_url: *331 sha_pinning_required: *130 required: - enabled @@ -53068,8 +52666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53080,7 +52678,7 @@ paths: schema: type: object properties: - enabled: *336 + enabled: *332 allowed_actions: *129 sha_pinning_required: *130 required: @@ -53112,14 +52710,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &337 + schema: &333 type: object properties: access_level: @@ -53136,7 +52734,7 @@ paths: required: - access_level examples: - default: &338 + default: &334 value: access_level: organization x-github: @@ -53160,15 +52758,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *337 + schema: *333 examples: - default: *338 + default: *334 responses: '204': description: Response @@ -53192,14 +52790,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *339 + schema: *335 examples: default: value: @@ -53223,8 +52821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Empty response for successful settings update @@ -53234,7 +52832,7 @@ paths: required: true content: application/json: - schema: *340 + schema: *336 examples: default: summary: Set retention days @@ -53258,8 +52856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53267,7 +52865,7 @@ paths: application/json: schema: *131 examples: - default: *341 + default: *337 '404': *6 x-github: enabledForGitHubApps: true @@ -53286,8 +52884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53321,14 +52919,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *342 + schema: *338 examples: default: *132 '403': *27 @@ -53350,13 +52948,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *343 + schema: *339 examples: default: *132 responses: @@ -53382,8 +52980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53410,8 +53008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -53443,14 +53041,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *344 + schema: *340 examples: default: *139 x-github: @@ -53473,8 +53071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Success response @@ -53485,7 +53083,7 @@ paths: required: true content: application/json: - schema: *345 + schema: *341 examples: default: *139 x-github: @@ -53514,8 +53112,8 @@ paths: in: query schema: type: string - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -53559,8 +53157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -53568,9 +53166,9 @@ paths: application/json: schema: type: array - items: *346 + items: *342 examples: - default: *347 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53592,8 +53190,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -53636,7 +53234,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *348 + '201': *344 '404': *6 '422': *7 '409': *49 @@ -53667,8 +53265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -53676,7 +53274,7 @@ paths: application/json: schema: *148 examples: - default: *349 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53704,8 +53302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -53713,7 +53311,7 @@ paths: application/json: schema: *148 examples: - default: *350 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53735,8 +53333,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '200': @@ -53745,7 +53343,7 @@ paths: application/json: schema: *146 examples: - default: *351 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53766,8 +53364,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '204': @@ -53794,8 +53392,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: '200': *150 @@ -53820,8 +53418,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: - - *318 - - *319 + - *314 + - *315 - *145 requestBody: required: true @@ -53870,8 +53468,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: - - *318 - - *319 + - *314 + - *315 - *145 requestBody: required: true @@ -53921,11 +53519,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: - - *318 - - *319 + - *314 + - *315 - *145 responses: - '200': *352 + '200': *348 '404': *6 x-github: githubCloudOnly: false @@ -53952,10 +53550,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: - - *318 - - *319 + - *314 + - *315 - *145 - - *353 + - *349 responses: '200': *150 '404': *6 @@ -53983,9 +53581,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *318 - - *319 - - &371 + - *314 + - *315 + - &367 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. @@ -53993,7 +53591,7 @@ paths: required: false schema: type: string - - &372 + - &368 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54001,7 +53599,7 @@ paths: required: false schema: type: string - - &373 + - &369 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54010,7 +53608,7 @@ paths: required: false schema: type: string - - &374 + - &370 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 @@ -54037,7 +53635,7 @@ paths: - pending - *17 - *19 - - &375 + - &371 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)." @@ -54046,7 +53644,7 @@ paths: schema: type: string format: date-time - - &354 + - &350 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54055,13 +53653,13 @@ paths: schema: type: boolean default: false - - &376 + - &372 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &377 + - &373 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54084,7 +53682,7 @@ paths: type: integer workflow_runs: type: array - items: &355 + items: &351 title: Workflow Run description: An invocation of a workflow type: object @@ -54262,7 +53860,7 @@ paths: head_commit: anyOf: - type: 'null' - - &399 + - &395 title: Simple Commit description: A commit. type: object @@ -54377,7 +53975,7 @@ paths: - workflow_url - pull_requests examples: - default: &378 + default: &374 value: total_count: 1 workflow_runs: @@ -54613,24 +54211,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *318 - - *319 - - &356 + - *314 + - *315 + - &352 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *354 + - *350 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: - default: &359 + default: &355 value: id: 30433642 name: Build @@ -54871,9 +54469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '204': description: Response @@ -54896,9 +54494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -55026,9 +54624,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: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '201': description: Response @@ -55061,12 +54659,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 - *17 - *19 - - *357 + - *353 responses: '200': description: Response @@ -55082,9 +54680,9 @@ paths: type: integer artifacts: type: array - items: *325 + items: *321 examples: - default: *358 + default: *354 headers: Link: *56 x-github: @@ -55108,25 +54706,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *318 - - *319 - - *356 - - &360 + - *314 + - *315 + - *352 + - &356 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *354 + - *350 responses: '200': description: Response content: application/json: - schema: *355 + schema: *351 examples: - default: *359 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55149,10 +54747,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *318 - - *319 + - *314 + - *315 + - *352 - *356 - - *360 - *17 - *19 responses: @@ -55170,9 +54768,9 @@ paths: type: integer jobs: type: array - items: *361 + items: *357 examples: - default: &362 + default: &358 value: total_count: 1 jobs: @@ -55285,10 +54883,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *318 - - *319 + - *314 + - *315 + - *352 - *356 - - *360 responses: '302': description: Response @@ -55316,9 +54914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '202': description: Response @@ -55351,9 +54949,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: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: true content: @@ -55420,9 +55018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '202': description: Response @@ -55455,9 +55053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 - 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 @@ -55487,9 +55085,9 @@ paths: type: integer jobs: type: array - items: *361 + items: *357 examples: - default: *362 + default: *358 headers: Link: *56 x-github: @@ -55514,9 +55112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '302': description: Response @@ -55543,9 +55141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '204': description: Response @@ -55572,9 +55170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -55643,7 +55241,7 @@ paths: items: type: object properties: - type: &477 + type: &475 type: string description: The type of reviewer. enum: @@ -55729,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: true content: @@ -55781,7 +55379,7 @@ paths: application/json: schema: type: array - items: &472 + items: &470 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -55893,7 +55491,7 @@ paths: - created_at - updated_at examples: - default: &473 + default: &471 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55949,9 +55547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: false content: @@ -55996,9 +55594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 requestBody: required: false content: @@ -56052,9 +55650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *318 - - *319 - - *356 + - *314 + - *315 + - *352 responses: '200': description: Response @@ -56191,8 +55789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -56210,9 +55808,9 @@ paths: type: integer secrets: type: array - items: *363 + items: *359 examples: - default: *364 + default: *360 headers: Link: *56 x-github: @@ -56237,16 +55835,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *365 + schema: *361 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56268,17 +55866,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *363 + schema: *359 examples: - default: &490 + default: &488 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56304,8 +55902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -56363,8 +55961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -56390,9 +55988,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *318 - - *319 - - *334 + - *314 + - *315 + - *330 - *19 responses: '200': @@ -56409,9 +56007,9 @@ paths: type: integer variables: type: array - items: *367 + items: *363 examples: - default: *368 + default: *364 headers: Link: *56 x-github: @@ -56434,8 +56032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -56487,17 +56085,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 responses: '200': description: Response content: application/json: - schema: *367 + schema: *363 examples: - default: &491 + default: &489 value: name: USERNAME value: octocat @@ -56523,8 +56121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 requestBody: required: true @@ -56567,8 +56165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 responses: '204': @@ -56594,8 +56192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -56613,7 +56211,7 @@ paths: type: integer workflows: type: array - items: &369 + items: &365 title: Workflow description: A GitHub Actions workflow type: object @@ -56731,9 +56329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *318 - - *319 - - &370 + - *314 + - *315 + - &366 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56748,7 +56346,7 @@ paths: description: Response content: application/json: - schema: *369 + schema: *365 examples: default: value: @@ -56781,9 +56379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56808,9 +56406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56861,9 +56459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '204': description: Response @@ -56890,19 +56488,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *318 - - *319 + - *314 + - *315 + - *366 + - *367 + - *368 + - *369 - *370 + - *17 + - *19 - *371 + - *350 - *372 - *373 - - *374 - - *17 - - *19 - - *375 - - *354 - - *376 - - *377 responses: '200': description: Response @@ -56918,9 +56516,9 @@ paths: type: integer workflow_runs: type: array - items: *355 + items: *351 examples: - default: *378 + default: *374 headers: Link: *56 x-github: @@ -56952,9 +56550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *318 - - *319 - - *370 + - *314 + - *315 + - *366 responses: '200': description: Response @@ -57015,8 +56613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *318 - - *319 + - *314 + - *315 - *50 - *17 - *43 @@ -57184,8 +56782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -57222,8 +56820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *318 - - *319 + - *314 + - *315 - name: assignee in: path required: true @@ -57259,8 +56857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -57372,8 +56970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *43 - *44 @@ -57430,7 +57028,7 @@ paths: initiator: type: string examples: - default: *379 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57450,8 +57048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -57459,7 +57057,7 @@ paths: application/json: schema: type: array - items: &380 + items: &376 title: Autolink reference description: An autolink reference. type: object @@ -57518,8 +57116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -57558,9 +57156,9 @@ paths: description: response content: application/json: - schema: *380 + schema: *376 examples: - default: &381 + default: &377 value: id: 1 key_prefix: TICKET- @@ -57591,9 +57189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *318 - - *319 - - &382 + - *314 + - *315 + - &378 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57605,9 +57203,9 @@ paths: description: Response content: application/json: - schema: *380 + schema: *376 examples: - default: *381 + default: *377 '404': *6 x-github: githubCloudOnly: false @@ -57627,9 +57225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *318 - - *319 - - *382 + - *314 + - *315 + - *378 responses: '204': description: Response @@ -57653,8 +57251,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response if Dependabot is enabled @@ -57704,8 +57302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -57726,8 +57324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -57747,8 +57345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *318 - - *319 + - *314 + - *315 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57786,7 +57384,7 @@ paths: - url protected: type: boolean - protection: &384 + protection: &380 title: Branch Protection description: Branch Protection type: object @@ -57829,7 +57427,7 @@ paths: required: - contexts - checks - enforce_admins: &387 + enforce_admins: &383 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57846,7 +57444,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &389 + required_pull_request_reviews: &385 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57930,7 +57528,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &386 + restrictions: &382 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58223,9 +57821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *318 - - *319 - - &385 + - *314 + - *315 + - &381 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). @@ -58239,14 +57837,14 @@ paths: description: Response content: application/json: - schema: &395 + schema: &391 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &447 + commit: &445 title: Commit description: Commit type: object @@ -58285,7 +57883,7 @@ paths: author: anyOf: - type: 'null' - - &383 + - &379 title: Git User description: Metaproperties for Git author/committer information. @@ -58307,7 +57905,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 message: type: string examples: @@ -58331,7 +57929,7 @@ paths: required: - sha - url - verification: &497 + verification: &495 title: Verification type: object properties: @@ -58411,7 +58009,7 @@ paths: type: integer files: type: array - items: &458 + items: &456 title: Diff Entry description: Diff Entry type: object @@ -58507,7 +58105,7 @@ paths: - self protected: type: boolean - protection: *384 + protection: *380 protection_url: type: string format: uri @@ -58616,7 +58214,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *322 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -58638,15 +58236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *384 + schema: *380 examples: default: value: @@ -58840,9 +58438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -59102,7 +58700,7 @@ paths: url: type: string format: uri - required_status_checks: &392 + required_status_checks: &388 title: Status Check Policy description: Status Check Policy type: object @@ -59261,7 +58859,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *386 + restrictions: *382 required_conversation_resolution: type: object properties: @@ -59373,9 +58971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59400,17 +58998,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: &388 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -59432,17 +59030,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: *388 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59461,9 +59059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59488,17 +59086,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *389 + schema: *385 examples: - default: &390 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59594,9 +59192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -59694,9 +59292,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *385 examples: - default: *390 + default: *386 '422': *15 x-github: githubCloudOnly: false @@ -59717,9 +59315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59746,17 +59344,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: &391 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59779,17 +59377,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *387 + schema: *383 examples: - default: *391 + default: *387 '404': *6 x-github: githubCloudOnly: false @@ -59809,9 +59407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59836,17 +59434,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *392 + schema: *388 examples: - default: &393 + default: &389 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59872,9 +59470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -59926,9 +59524,9 @@ paths: description: Response content: application/json: - schema: *392 + schema: *388 examples: - default: *393 + default: *389 '404': *6 '422': *15 x-github: @@ -59950,9 +59548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -59976,9 +59574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60012,9 +59610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60081,9 +59679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60147,9 +59745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: content: application/json: @@ -60215,15 +59813,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response content: application/json: - schema: *386 + schema: *382 examples: default: value: @@ -60314,9 +59912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '204': description: Response @@ -60339,9 +59937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60351,7 +59949,7 @@ paths: type: array items: *5 examples: - default: &394 + default: &390 value: - id: 1 slug: octoapp @@ -60408,9 +60006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60444,7 +60042,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60465,9 +60063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60501,7 +60099,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60522,9 +60120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60558,7 +60156,7 @@ paths: type: array items: *5 examples: - default: *394 + default: *390 '422': *15 x-github: githubCloudOnly: false @@ -60580,9 +60178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60612,9 +60210,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60673,9 +60271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: false content: @@ -60734,9 +60332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: content: application/json: @@ -60795,9 +60393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 responses: '200': description: Response @@ -60831,9 +60429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60891,9 +60489,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -60951,9 +60549,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -61013,9 +60611,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 requestBody: required: true content: @@ -61037,7 +60635,7 @@ paths: description: Response content: application/json: - schema: *395 + schema: *391 examples: default: value: @@ -61153,8 +60751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -61433,7 +61031,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &392 title: CheckRun description: A check performed on the code of a given code change type: object @@ -61856,9 +61454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *318 - - *319 - - &397 + - *314 + - *315 + - &393 name: check_run_id description: The unique identifier of the check run. in: path @@ -61870,9 +61468,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: &398 + default: &394 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61972,9 +61570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 requestBody: required: true content: @@ -62214,9 +61812,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *392 examples: - default: *398 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62236,9 +61834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 - *17 - *19 responses: @@ -62348,9 +61946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *318 - - *319 - - *397 + - *314 + - *315 + - *393 responses: '201': description: Response @@ -62394,8 +61992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -62417,7 +62015,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &400 + schema: &396 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -62515,7 +62113,7 @@ paths: - string - 'null' format: date-time - head_commit: *399 + head_commit: *395 latest_check_runs_count: type: integer check_runs_url: @@ -62543,7 +62141,7 @@ paths: - check_runs_url - pull_requests examples: - default: &401 + default: &397 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62834,9 +62432,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *400 + schema: *396 examples: - default: *401 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62855,8 +62453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -63165,9 +62763,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *318 - - *319 - - &402 + - *314 + - *315 + - &398 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63179,9 +62777,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *396 examples: - default: *401 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63204,17 +62802,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *318 - - *319 - - *402 - - &453 + - *314 + - *315 + - *398 + - &451 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &454 + - &452 name: status description: Returns check runs with the specified `status`. in: query @@ -63253,9 +62851,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *392 examples: - default: &455 + default: &453 value: total_count: 1 check_runs: @@ -63357,9 +62955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *318 - - *319 - - *402 + - *314 + - *315 + - *398 responses: '201': description: Response @@ -63392,21 +62990,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *318 - - *319 - - *403 - - *404 + - *314 + - *315 + - *399 + - *400 - *19 - *17 - - &421 + - &417 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: *405 - - &422 + schema: *401 + - &418 name: pr description: The number of the pull request for the results you want to list. in: query @@ -63431,13 +63029,13 @@ paths: be returned. in: query required: false - schema: *406 + schema: *402 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *407 + schema: *403 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -63461,7 +63059,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: *408 + instances_url: *404 state: *171 fixed_at: *167 dismissed_by: @@ -63469,11 +63067,11 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: *409 - dismissed_comment: *410 - rule: *411 - tool: *412 - most_recent_instance: *413 + dismissed_reason: *405 + dismissed_comment: *406 + rule: *407 + tool: *408 + most_recent_instance: *409 dismissal_approved_by: anyOf: - type: 'null' @@ -63596,7 +63194,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &414 + '403': &410 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -63623,9 +63221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *318 - - *319 - - &415 + - *314 + - *315 + - &411 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63639,7 +63237,7 @@ paths: description: Response content: application/json: - schema: &416 + schema: &412 type: object properties: number: *162 @@ -63647,7 +63245,7 @@ paths: updated_at: *164 url: *165 html_url: *166 - instances_url: *408 + instances_url: *404 state: *171 fixed_at: *167 dismissed_by: @@ -63655,8 +63253,8 @@ paths: - type: 'null' - *4 dismissed_at: *168 - dismissed_reason: *409 - dismissed_comment: *410 + dismissed_reason: *405 + dismissed_comment: *406 rule: type: object properties: @@ -63718,8 +63316,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *412 - most_recent_instance: *413 + tool: *408 + most_recent_instance: *409 dismissal_approved_by: anyOf: - type: 'null' @@ -63815,7 +63413,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -63835,9 +63433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: true content: @@ -63852,8 +63450,8 @@ paths: enum: - open - dismissed - dismissed_reason: *409 - dismissed_comment: *410 + dismissed_reason: *405 + dismissed_comment: *406 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63881,7 +63479,7 @@ paths: description: Response content: application/json: - schema: *416 + schema: *412 examples: default: value: @@ -63957,7 +63555,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &420 + '403': &416 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -63984,15 +63582,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 responses: '200': description: Response content: application/json: - schema: &417 + schema: &413 type: object properties: status: @@ -64019,13 +63617,13 @@ paths: - description - started_at examples: - default: &418 + default: &414 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &419 + '400': &415 description: Bad Request content: application/json: @@ -64036,7 +63634,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': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64061,29 +63659,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 responses: '200': description: OK content: application/json: - schema: *417 + schema: *413 examples: - default: *418 + default: *414 '202': description: Accepted content: application/json: - schema: *417 + schema: *413 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *419 + '400': *415 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64115,9 +63713,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: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: false content: @@ -64163,8 +63761,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *419 - '403': *420 + '400': *415 + '403': *416 '404': *6 '422': description: Unprocessable Entity @@ -64188,13 +63786,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *19 - *17 - - *421 - - *422 + - *417 + - *418 responses: '200': description: Response @@ -64205,10 +63803,10 @@ paths: items: type: object properties: - ref: *405 - analysis_key: *423 - environment: *424 - category: *425 + ref: *401 + analysis_key: *419 + environment: *420 + category: *421 state: type: - string @@ -64225,7 +63823,7 @@ paths: properties: text: type: string - location: *426 + location: *422 html_url: type: string classifications: @@ -64233,7 +63831,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: *427 + items: *423 examples: default: value: @@ -64272,7 +63870,7 @@ paths: end_column: 50 classifications: - source - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64306,25 +63904,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *318 - - *319 - - *403 - - *404 + - *314 + - *315 + - *399 + - *400 - *19 - *17 - - *422 + - *418 - 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: *405 + schema: *401 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &428 + schema: &424 type: string description: An identifier for the upload. examples: @@ -64346,23 +63944,23 @@ paths: application/json: schema: type: array - items: &429 + items: &425 type: object properties: - ref: *405 - commit_sha: &437 + ref: *401 + commit_sha: &433 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: *423 + analysis_key: *419 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *425 + category: *421 error: type: string examples: @@ -64387,8 +63985,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *428 - tool: *412 + sarif_id: *424 + tool: *408 deletable: type: boolean warning: @@ -64450,7 +64048,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64486,8 +64084,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: - - *318 - - *319 + - *314 + - *315 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64500,7 +64098,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *425 examples: response: summary: application/json response @@ -64554,7 +64152,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *414 + '403': *410 '404': *6 '422': description: Response if analysis could not be processed @@ -64641,8 +64239,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: - - *318 - - *319 + - *314 + - *315 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64698,7 +64296,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': *420 + '403': *416 '404': *6 '503': *105 x-github: @@ -64720,8 +64318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -64729,7 +64327,7 @@ paths: application/json: schema: type: array - items: &430 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -64841,7 +64439,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': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64870,8 +64468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: language in: path description: The language of the CodeQL database. @@ -64883,7 +64481,7 @@ paths: description: Response content: application/json: - schema: *430 + schema: *426 examples: default: value: @@ -64915,9 +64513,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': &460 + '302': &458 description: Found - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -64939,8 +64537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *318 - - *319 + - *314 + - *315 - name: language in: path description: The language of the CodeQL database. @@ -64950,7 +64548,7 @@ paths: responses: '204': description: Response - '403': *420 + '403': *416 '404': *6 '503': *105 x-github: @@ -64978,8 +64576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -64988,7 +64586,7 @@ paths: type: object additionalProperties: false properties: - language: &431 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -65068,7 +64666,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &435 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -65078,7 +64676,7 @@ paths: description: The ID of the variant analysis. controller_repo: *55 actor: *4 - query_language: *431 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -65126,7 +64724,7 @@ paths: items: type: object properties: - repository: &432 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -65168,7 +64766,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &436 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65200,7 +64798,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &433 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -65215,7 +64813,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: *432 + items: *428 required: - repository_count - repositories @@ -65238,8 +64836,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *433 - over_limit_repos: *433 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -65255,7 +64853,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &434 + value: &430 summary: Default response value: id: 1 @@ -65401,10 +64999,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *434 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *434 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission @@ -65432,8 +65030,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: - - *318 - - *319 + - *314 + - *315 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -65445,9 +65043,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *431 examples: - default: *434 + default: *430 '404': *6 '503': *105 x-github: @@ -65470,7 +65068,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: - - *318 + - *314 - name: repo in: path description: The name of the controller repository. @@ -65505,7 +65103,7 @@ paths: type: object properties: repository: *55 - analysis_status: *436 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65630,8 +65228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -65724,7 +65322,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *414 + '403': *410 '404': *6 '503': *105 x-github: @@ -65745,8 +65343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -65840,7 +65438,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *420 + '403': *416 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65911,8 +65509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -65920,7 +65518,7 @@ paths: schema: type: object properties: - commit_sha: *437 + commit_sha: *433 ref: type: string description: |- @@ -65980,7 +65578,7 @@ paths: schema: type: object properties: - id: *428 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -65994,7 +65592,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': *420 + '403': *416 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -66017,8 +65615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *318 - - *319 + - *314 + - *315 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -66066,7 +65664,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': *414 + '403': *410 '404': description: Not Found if the sarif id does not match any upload '503': *105 @@ -66091,8 +65689,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66173,8 +65771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *318 - - *319 + - *314 + - *315 - 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 @@ -66302,8 +65900,8 @@ paths: parameters: - *17 - *19 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66617,8 +66215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -66684,7 +66282,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -66692,7 +66290,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '400': *14 '401': *23 '403': *27 @@ -66721,8 +66319,8 @@ paths: parameters: - *17 - *19 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -66786,8 +66384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66824,7 +66422,7 @@ paths: type: integer machines: type: array - items: *439 + items: *435 examples: default: &651 value: @@ -66866,8 +66464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *318 - - *319 + - *314 + - *315 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66954,8 +66552,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: - - *318 - - *319 + - *314 + - *315 - 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 @@ -67024,8 +66622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -67043,7 +66641,7 @@ paths: type: integer secrets: type: array - items: &443 + items: &439 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -67064,7 +66662,7 @@ paths: - created_at - updated_at examples: - default: *440 + default: *436 headers: Link: *56 x-github: @@ -67087,16 +66685,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *441 + schema: *437 examples: - default: *442 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67116,17 +66714,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *443 + schema: *439 examples: - default: *444 + default: *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67146,8 +66744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -67200,8 +66798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -67230,8 +66828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *318 - - *319 + - *314 + - *315 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67269,7 +66867,7 @@ paths: application/json: schema: type: array - items: &445 + items: &441 title: Collaborator description: Collaborator type: object @@ -67462,8 +67060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '204': @@ -67510,8 +67108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 requestBody: required: false @@ -67538,7 +67136,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &510 + schema: &508 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -67766,8 +67364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '204': @@ -67799,8 +67397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *318 - - *319 + - *314 + - *315 - *61 responses: '200': @@ -67821,7 +67419,7 @@ paths: user: anyOf: - type: 'null' - - *445 + - *441 required: - permission - role_name @@ -67875,8 +67473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -67886,7 +67484,7 @@ paths: application/json: schema: type: array - items: &446 + items: &442 title: Commit Comment description: Commit Comment type: object @@ -67944,7 +67542,7 @@ paths: - created_at - updated_at examples: - default: &449 + default: &447 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68003,17 +67601,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': description: Response content: application/json: - schema: *446 + schema: *442 examples: - default: &450 + default: &448 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68070,8 +67668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -68094,7 +67692,7 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: default: value: @@ -68145,8 +67743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -68168,8 +67766,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -68196,9 +67794,75 @@ paths: application/json: schema: type: array - items: *313 + items: &443 + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - *4 + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *315 + default: &512 + 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: *56 '404': *6 @@ -68219,8 +67883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -68253,16 +67917,40 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: &444 + 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: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -68284,10 +67972,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - &513 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -68336,8 +68030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *318 - - *319 + - *314 + - *315 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -68393,7 +68087,7 @@ paths: application/json: schema: type: array - items: *447 + items: *445 examples: default: &559 value: @@ -68489,9 +68183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *318 - - *319 - - &448 + - *314 + - *315 + - &446 name: commit_sha description: The SHA of the commit. in: path @@ -68563,9 +68257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 - *17 - *19 responses: @@ -68575,9 +68269,9 @@ paths: application/json: schema: type: array - items: *446 + items: *442 examples: - default: *449 + default: *447 headers: Link: *56 x-github: @@ -68605,9 +68299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 requestBody: required: true content: @@ -68642,9 +68336,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *442 examples: - default: *450 + default: *448 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68672,9 +68366,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 - *17 - *19 responses: @@ -68684,7 +68378,7 @@ paths: application/json: schema: type: array - items: *451 + items: *449 examples: default: &551 value: @@ -69223,11 +68917,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 - - &452 + - &450 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)" @@ -69242,7 +68936,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *445 examples: default: &537 value: @@ -69357,11 +69051,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *318 - - *319 + - *314 + - *315 + - *450 + - *451 - *452 - - *453 - - *454 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -69395,9 +69089,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *392 examples: - default: *455 + default: *453 headers: Link: *56 x-github: @@ -69422,9 +69116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -69432,7 +69126,7 @@ paths: schema: type: integer example: 1 - - *453 + - *451 - *17 - *19 responses: @@ -69450,7 +69144,7 @@ paths: type: integer check_suites: type: array - items: *400 + items: *396 examples: default: value: @@ -69650,9 +69344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - *17 - *19 responses: @@ -69854,9 +69548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *318 - - *319 - - *452 + - *314 + - *315 + - *450 - *17 - *19 responses: @@ -69947,7 +69641,7 @@ paths: site_admin: false headers: Link: *56 - '301': *322 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69975,8 +69669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -70009,11 +69703,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *456 + - *454 code_of_conduct_file: anyOf: - type: 'null' - - &457 + - &455 title: Community Health File type: object properties: @@ -70033,19 +69727,19 @@ paths: contributing: anyOf: - type: 'null' - - *457 + - *455 readme: anyOf: - type: 'null' - - *457 + - *455 issue_template: anyOf: - type: 'null' - - *457 + - *455 pull_request_template: anyOf: - type: 'null' - - *457 + - *455 required: - code_of_conduct - code_of_conduct_file @@ -70174,8 +69868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 - name: basehead @@ -70223,8 +69917,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *447 - merge_base_commit: *447 + base_commit: *445 + merge_base_commit: *445 status: type: string enum: @@ -70248,10 +69942,10 @@ paths: - 6 commits: type: array - items: *447 + items: *445 files: type: array - items: *458 + items: *456 required: - url - html_url @@ -70537,8 +70231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -70691,7 +70385,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &459 + response-if-content-is-a-file: &457 summary: Response if content is a file value: type: file @@ -71046,7 +70740,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *459 + response-if-content-is-a-file: *457 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71115,7 +70809,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *460 + '302': *458 '304': *35 x-github: githubCloudOnly: false @@ -71138,8 +70832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -71234,7 +70928,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &459 title: File Commit description: File Commit type: object @@ -71390,7 +71084,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: example-for-creating-a-file: value: @@ -71444,7 +71138,7 @@ paths: schema: oneOf: - *3 - - &492 + - &490 description: Repository rule violation was detected type: object properties: @@ -71497,8 +71191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *318 - - *319 + - *314 + - *315 - name: path description: path parameter in: path @@ -71559,7 +71253,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -71614,8 +71308,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *318 - - *319 + - *314 + - *315 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71739,8 +71433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *181 - *182 - *183 @@ -71752,7 +71446,7 @@ paths: schema: type: string - *185 - - *462 + - *460 - *186 - *187 - *50 @@ -71773,7 +71467,7 @@ paths: application/json: schema: type: array - items: &466 + items: &464 type: object description: A Dependabot alert. properties: @@ -71823,7 +71517,7 @@ paths: - direct - transitive - - security_advisory: *463 + security_advisory: *461 security_vulnerability: *54 url: *165 html_url: *166 @@ -71854,8 +71548,8 @@ paths: dismissal. maxLength: 280 fixed_at: *167 - auto_dismissed_at: *464 - dismissal_request: *465 + auto_dismissed_at: *462 + dismissal_request: *463 required: - number - state @@ -72085,9 +71779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *318 - - *319 - - &467 + - *314 + - *315 + - &465 name: alert_number in: path description: |- @@ -72102,7 +71796,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: value: @@ -72215,9 +71909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *318 - - *319 - - *467 + - *314 + - *315 + - *465 requestBody: required: true content: @@ -72262,7 +71956,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *464 examples: default: value: @@ -72391,8 +72085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -72410,7 +72104,7 @@ paths: type: integer secrets: type: array - items: &470 + items: &468 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -72464,16 +72158,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: *469 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72493,15 +72187,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '200': description: Response content: application/json: - schema: *470 + schema: *468 examples: default: value: @@ -72527,8 +72221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 requestBody: required: true @@ -72581,8 +72275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *318 - - *319 + - *314 + - *315 - *152 responses: '204': @@ -72605,8 +72299,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: - - *318 - - *319 + - *314 + - *315 - 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 @@ -72780,8 +72474,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -73041,8 +72735,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -73125,7 +72819,7 @@ paths: - version - url additionalProperties: false - metadata: &471 + metadata: &469 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73164,7 +72858,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *471 + metadata: *469 resolved: type: object description: A collection of resolved package dependencies. @@ -73178,7 +72872,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *471 + metadata: *469 relationship: type: string description: A notation of whether a dependency is requested @@ -73311,8 +73005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *318 - - *319 + - *314 + - *315 - name: sha description: The SHA recorded at creation time. in: query @@ -73353,9 +73047,9 @@ paths: application/json: schema: type: array - items: *472 + items: *470 examples: - default: *473 + default: *471 headers: Link: *56 x-github: @@ -73421,8 +73115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -73504,7 +73198,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *470 examples: simple-example: summary: Simple example @@ -73577,9 +73271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *318 - - *319 - - &474 + - *314 + - *315 + - &472 name: deployment_id description: deployment_id parameter in: path @@ -73591,7 +73285,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *470 examples: default: value: @@ -73656,9 +73350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 responses: '204': description: Response @@ -73680,9 +73374,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 - *17 - *19 responses: @@ -73692,7 +73386,7 @@ paths: application/json: schema: type: array - items: &475 + items: &473 title: Deployment Status description: The status of a deployment. type: object @@ -73856,9 +73550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 requestBody: required: true content: @@ -73933,9 +73627,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *473 examples: - default: &476 + default: &474 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -73991,9 +73685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *318 - - *319 - - *474 + - *314 + - *315 + - *472 - name: status_id in: path required: true @@ -74004,9 +73698,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *473 examples: - default: *476 + default: *474 '404': *6 x-github: githubCloudOnly: false @@ -74031,8 +73725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -74089,8 +73783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -74108,7 +73802,7 @@ paths: - 5 environments: type: array - items: &478 + items: &476 title: Environment description: Details of a deployment environment type: object @@ -74170,7 +73864,7 @@ paths: type: string examples: - wait_timer - wait_timer: &480 + wait_timer: &478 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -74212,7 +73906,7 @@ paths: items: type: object properties: - type: *477 + type: *475 reviewer: anyOf: - *4 @@ -74239,7 +73933,7 @@ paths: - id - node_id - type - deployment_branch_policy: &481 + deployment_branch_policy: &479 type: - object - 'null' @@ -74356,9 +74050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *318 - - *319 - - &479 + - *314 + - *315 + - &477 name: environment_name in: path required: true @@ -74371,9 +74065,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *476 examples: - default: &482 + default: &480 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -74457,9 +74151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: false content: @@ -74469,7 +74163,7 @@ paths: - object - 'null' properties: - wait_timer: *480 + wait_timer: *478 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -74488,14 +74182,14 @@ paths: items: type: object properties: - type: *477 + type: *475 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *481 + deployment_branch_policy: *479 additionalProperties: false examples: default: @@ -74515,9 +74209,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *476 examples: - default: *482 + default: *480 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -74541,9 +74235,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 responses: '204': description: Default response @@ -74568,9 +74262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *17 - *19 responses: @@ -74589,7 +74283,7 @@ paths: - 2 branch_policies: type: array - items: &483 + items: &481 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -74650,9 +74344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: true content: @@ -74700,9 +74394,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - example-wildcard: &484 + example-wildcard: &482 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74744,10 +74438,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - &485 + - *314 + - *315 + - *477 + - &483 name: branch_policy_id in: path required: true @@ -74759,9 +74453,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - default: *484 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74780,10 +74474,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - *485 + - *314 + - *315 + - *477 + - *483 requestBody: required: true content: @@ -74812,9 +74506,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: - default: *484 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74833,10 +74527,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *318 - - *319 - - *479 - - *485 + - *314 + - *315 + - *477 + - *483 responses: '204': description: Response @@ -74861,9 +74555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 responses: '200': description: List of deployment protection rules @@ -74880,7 +74574,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &486 + items: &484 title: Deployment protection rule description: Deployment protection rule type: object @@ -74902,7 +74596,7 @@ paths: for the environment. examples: - true - app: &487 + app: &485 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -75005,9 +74699,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: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 requestBody: content: application/json: @@ -75028,9 +74722,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *486 + schema: *484 examples: - default: &488 + default: &486 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75065,9 +74759,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: - - *479 - - *319 - - *318 + - *477 + - *315 + - *314 - *19 - *17 responses: @@ -75087,7 +74781,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *487 + items: *485 examples: default: value: @@ -75122,10 +74816,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *318 - - *319 - - *479 - - &489 + - *314 + - *315 + - *477 + - &487 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75137,9 +74831,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: *488 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,10 +74854,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *479 - - *319 - - *318 - - *489 + - *477 + - *315 + - *314 + - *487 responses: '204': description: Response @@ -75189,9 +74883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *17 - *19 responses: @@ -75209,9 +74903,9 @@ paths: type: integer secrets: type: array - items: *363 + items: *359 examples: - default: *364 + default: *360 headers: Link: *56 x-github: @@ -75236,17 +74930,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 responses: '200': description: Response content: application/json: - schema: *365 + schema: *361 examples: - default: *366 + default: *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75268,18 +74962,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 responses: '200': description: Response content: application/json: - schema: *363 + schema: *359 examples: - default: *490 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75301,9 +74995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 requestBody: required: true @@ -75361,9 +75055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *152 responses: '204': @@ -75389,10 +75083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *318 - - *319 - - *479 - - *334 + - *314 + - *315 + - *477 + - *330 - *19 responses: '200': @@ -75409,9 +75103,9 @@ paths: type: integer variables: type: array - items: *367 + items: *363 examples: - default: *368 + default: *364 headers: Link: *56 x-github: @@ -75434,9 +75128,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 requestBody: required: true content: @@ -75488,18 +75182,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *318 - - *319 - - *479 + - *314 + - *315 + - *477 - *155 responses: '200': description: Response content: application/json: - schema: *367 + schema: *363 examples: - default: *491 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75520,10 +75214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 - - *479 + - *477 requestBody: required: true content: @@ -75565,10 +75259,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *318 - - *319 + - *314 + - *315 - *155 - - *479 + - *477 responses: '204': description: Response @@ -75590,8 +75284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -75659,8 +75353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *318 - - *319 + - *314 + - *315 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75819,8 +75513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -75853,9 +75547,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 '400': *14 '422': *15 '403': *27 @@ -75876,8 +75570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -75937,7 +75631,7 @@ paths: schema: oneOf: - *113 - - *492 + - *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75962,8 +75656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *318 - - *319 + - *314 + - *315 - name: file_sha in: path required: true @@ -76063,8 +75757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76173,7 +75867,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &491 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -76400,15 +76094,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *318 - - *319 - - *448 + - *314 + - *315 + - *446 responses: '200': description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -76464,9 +76158,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *318 - - *319 - - &494 + - *314 + - *315 + - &492 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. @@ -76483,7 +76177,7 @@ paths: application/json: schema: type: array - items: &495 + items: &493 title: Git Reference description: Git references within a repository type: object @@ -76559,17 +76253,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 responses: '200': description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: &496 + default: &494 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -76598,8 +76292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76628,9 +76322,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: *496 + default: *494 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -76656,9 +76350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 requestBody: required: true content: @@ -76687,9 +76381,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: - default: *496 + default: *494 '422': *15 '409': *49 x-github: @@ -76707,9 +76401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *318 - - *319 - - *494 + - *314 + - *315 + - *492 responses: '204': description: Response @@ -76764,8 +76458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -76832,7 +76526,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &496 title: Git Tag description: Metadata for a Git tag type: object @@ -76888,7 +76582,7 @@ paths: - sha - type - url - verification: *497 + verification: *495 required: - sha - url @@ -76898,7 +76592,7 @@ paths: - tag - message examples: - default: &499 + default: &497 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76971,8 +76665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *318 - - *319 + - *314 + - *315 - name: tag_sha in: path required: true @@ -76983,9 +76677,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *496 examples: - default: *499 + default: *497 '404': *6 '409': *49 x-github: @@ -77009,8 +76703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -77084,7 +76778,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &498 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -77186,8 +76880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *318 - - *319 + - *314 + - *315 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -77210,7 +76904,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *498 examples: default-response: summary: Default response @@ -77269,8 +76963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -77280,7 +76974,7 @@ paths: application/json: schema: type: array - items: &501 + items: &499 title: Webhook description: Webhooks for repositories. type: object @@ -77420,8 +77114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -77474,9 +77168,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: &502 + default: &500 value: type: Repository id: 12345678 @@ -77524,17 +77218,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '200': description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: *502 + default: *500 '404': *6 x-github: githubCloudOnly: false @@ -77554,8 +77248,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 requestBody: required: true @@ -77601,9 +77295,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *499 examples: - default: *502 + default: *500 '422': *15 '404': *6 x-github: @@ -77624,8 +77318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77650,8 +77344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '200': @@ -77679,8 +77373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *193 requestBody: required: false @@ -77725,8 +77419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *17 - *194 @@ -77758,8 +77452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *16 responses: @@ -77788,8 +77482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 - *16 responses: @@ -77813,8 +77507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77840,8 +77534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *318 - - *319 + - *314 + - *315 - *193 responses: '204': @@ -77865,8 +77559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response if immutable releases are enabled @@ -77914,8 +77608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '409': *49 @@ -77935,8 +77629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '409': *49 @@ -77993,14 +77687,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response content: application/json: - schema: &503 + schema: &501 title: Import description: A repository import from an external source. type: object @@ -78107,7 +77801,7 @@ paths: - html_url - authors_url examples: - default: &506 + default: &504 value: vcs: subversion use_lfs: true @@ -78123,7 +77817,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': &504 + '503': &502 description: Unavailable due to service under maintenance. content: application/json: @@ -78152,8 +77846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -78201,7 +77895,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: default: value: @@ -78226,7 +77920,7 @@ paths: type: string '422': *15 '404': *6 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78254,8 +77948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -78307,7 +78001,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: example-1: summary: Example 1 @@ -78355,7 +78049,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': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78378,12 +78072,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78409,8 +78103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *318 - - *319 + - *314 + - *315 - &672 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -78425,7 +78119,7 @@ paths: application/json: schema: type: array - items: &505 + items: &503 title: Porter Author description: Porter Author type: object @@ -78479,7 +78173,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': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78504,8 +78198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *318 - - *319 + - *314 + - *315 - name: author_id in: path required: true @@ -78535,7 +78229,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *503 examples: default: value: @@ -78548,7 +78242,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78572,8 +78266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78614,7 +78308,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78642,8 +78336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -78670,11 +78364,11 @@ paths: description: Response content: application/json: - schema: *503 + schema: *501 examples: - default: *506 + default: *504 '422': *15 - '503': *504 + '503': *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78697,8 +78391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78706,8 +78400,8 @@ paths: application/json: schema: *20 examples: - default: *507 - '301': *322 + default: *505 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -78727,8 +78421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -78741,7 +78435,7 @@ paths: properties: {} additionalProperties: false examples: - default: &509 + default: &507 value: limit: collaborators_only origin: repository @@ -78766,13 +78460,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: application/json: - schema: *508 + schema: *506 examples: default: summary: Example request body @@ -78786,7 +78480,7 @@ paths: application/json: schema: *211 examples: - default: *509 + default: *507 '409': description: Response x-github: @@ -78808,8 +78502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -78832,8 +78526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -78843,7 +78537,7 @@ paths: application/json: schema: type: array - items: *510 + items: *508 examples: default: &665 value: @@ -78976,8 +78670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *318 - - *319 + - *314 + - *315 - *215 requestBody: required: false @@ -79007,7 +78701,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *508 examples: default: value: @@ -79138,8 +78832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *318 - - *319 + - *314 + - *315 - *215 responses: '204': @@ -79171,8 +78865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *318 - - *319 + - *314 + - *315 - 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 @@ -79393,7 +79087,7 @@ paths: state_reason: completed headers: Link: *56 - '301': *322 + '301': *318 '422': *15 '404': *6 x-github: @@ -79422,8 +79116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -79671,7 +79365,7 @@ paths: '422': *15 '503': *105 '404': *6 - '410': *511 + '410': *509 x-github: triggersNotification: true githubCloudOnly: false @@ -79699,8 +79393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *93 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -79721,7 +79415,7 @@ paths: application/json: schema: type: array - items: *512 + items: *510 examples: default: &517 value: @@ -79781,17 +79475,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: &513 + default: &511 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79845,8 +79539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -79869,9 +79563,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -79889,8 +79583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -79911,8 +79605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79939,9 +79633,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -79962,8 +79656,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -79996,16 +79690,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -80027,10 +79721,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - *513 responses: '204': description: Response @@ -80050,8 +79744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -80400,8 +80094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *318 - - *319 + - *314 + - *315 - name: event_id in: path required: true @@ -80604,7 +80298,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *511 + '410': *509 '403': *27 x-github: githubCloudOnly: false @@ -80638,8 +80332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - &516 name: issue_number description: The number that identifies the issue. @@ -80655,9 +80349,9 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '304': *35 x-github: githubCloudOnly: false @@ -80682,8 +80376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -80809,9 +80503,9 @@ paths: '422': *15 '503': *105 '403': *27 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80829,8 +80523,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -80875,8 +80569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: content: @@ -80926,8 +80620,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: - - *318 - - *319 + - *314 + - *315 - *516 - name: assignee in: path @@ -80968,8 +80662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *76 - *17 @@ -80981,13 +80675,13 @@ paths: application/json: schema: type: array - items: *512 + items: *510 examples: default: *517 headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81016,8 +80710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -81040,16 +80734,16 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -81077,8 +80771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -81094,9 +80788,9 @@ paths: default: *518 headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81124,8 +80818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -81156,9 +80850,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *322 + '301': *318 '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -81189,8 +80883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: issue_id in: path @@ -81206,12 +80900,12 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *511 + '410': *509 x-github: triggersNotification: true githubCloudOnly: false @@ -81237,8 +80931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -81254,9 +80948,9 @@ paths: default: *518 headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81273,8 +80967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82068,7 +81762,7 @@ paths: color: red headers: Link: *56 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82085,8 +81779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82117,9 +81811,9 @@ paths: default: false headers: Link: *56 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82136,8 +81830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82200,9 +81894,9 @@ paths: items: *69 examples: default: *519 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '422': *15 x-github: githubCloudOnly: false @@ -82219,8 +81913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82284,9 +81978,9 @@ paths: items: *69 examples: default: *519 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 '422': *15 x-github: githubCloudOnly: false @@ -82303,15 +81997,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '204': description: Response - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82330,8 +82024,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: name in: path @@ -82356,9 +82050,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82378,8 +82072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: false @@ -82409,7 +82103,7 @@ paths: '204': description: Response '403': *27 - '410': *511 + '410': *509 '404': *6 '422': *15 x-github: @@ -82427,8 +82121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '204': @@ -82459,8 +82153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 responses: '200': @@ -82470,9 +82164,9 @@ paths: schema: *70 examples: default: *515 - '301': *322 + '301': *318 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82489,8 +82183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -82517,13 +82211,13 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82541,8 +82235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82575,16 +82269,16 @@ paths: description: Response content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Response content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -82606,10 +82300,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *516 - - *316 + - *513 responses: '204': description: Response @@ -82638,8 +82332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82697,8 +82391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -82715,7 +82409,7 @@ paths: headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82743,8 +82437,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82781,7 +82475,7 @@ paths: schema: type: string '403': *27 - '410': *511 + '410': *509 '422': *15 '404': *6 x-github: @@ -82801,8 +82495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 requestBody: required: true @@ -82858,8 +82552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *318 - - *319 + - *314 + - *315 - *516 - *17 - *19 @@ -83454,7 +83148,7 @@ paths: type: string comments: type: array - items: *446 + items: *442 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -83729,7 +83423,7 @@ paths: headers: Link: *56 '404': *6 - '410': *511 + '410': *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83746,8 +83440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -83825,8 +83519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -83898,8 +83592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 - &535 name: key_id description: The unique identifier of the key. @@ -83932,8 +83626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *318 - - *319 + - *314 + - *315 - *535 responses: '204': @@ -83954,8 +83648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -83988,8 +83682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84059,8 +83753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84090,8 +83784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84156,8 +83850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *318 - - *319 + - *314 + - *315 - name: name in: path required: true @@ -84183,8 +83877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -84223,9 +83917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *318 - - *319 - - *421 + - *314 + - *315 + - *417 responses: '200': description: Response @@ -84372,8 +84066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84438,8 +84132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84473,7 +84167,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *447 + schema: *445 examples: default: *537 '204': @@ -84500,8 +84194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *318 - - *319 + - *314 + - *315 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -84598,8 +84292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -84700,8 +84394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - &539 name: milestone_number description: The number that identifies the milestone. @@ -84733,8 +84427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 requestBody: required: false @@ -84791,8 +84485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 responses: '204': @@ -84814,8 +84508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *318 - - *319 + - *314 + - *315 - *539 - *17 - *19 @@ -84847,8 +84541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 - *540 - *541 - *76 @@ -84888,8 +84582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -84947,8 +84641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -85139,8 +84833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85220,8 +84914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85321,8 +85015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -85348,8 +85042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -85451,8 +85145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *318 - - *319 + - *314 + - *315 responses: '201': description: Response @@ -85499,8 +85193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -85556,8 +85250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *318 - - *319 + - *314 + - *315 - name: build_id in: path required: true @@ -85590,8 +85284,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -85699,8 +85393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 - &548 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -85759,8 +85453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *318 - - *319 + - *314 + - *315 - *548 responses: '204': *176 @@ -85788,8 +85482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -86084,8 +85778,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: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Private vulnerability reporting status @@ -86122,8 +85816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '422': *14 @@ -86144,8 +85838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': *176 '422': *14 @@ -86167,8 +85861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -86200,8 +85894,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -86255,8 +85949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *318 - - *319 + - *314 + - *315 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -86316,7 +86010,7 @@ paths: application/json: schema: type: array - items: *451 + items: *449 examples: default: *551 headers: @@ -86350,8 +86044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -87287,8 +86981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - name: sort in: query required: false @@ -87396,8 +87090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '200': @@ -87481,8 +87175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -87523,8 +87217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *85 responses: '204': @@ -87546,8 +87240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87574,9 +87268,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -87597,8 +87291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *85 requestBody: required: true @@ -87631,16 +87325,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -87662,10 +87356,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *85 - - *316 + - *513 responses: '204': description: Response @@ -87708,8 +87402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - &557 name: pull_number description: The number that identifies the pull request. @@ -87760,8 +87454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -87828,8 +87522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -87893,7 +87587,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -87901,7 +87595,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -87931,8 +87625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *93 - name: direction @@ -87989,8 +87683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -88185,8 +87879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *85 requestBody: @@ -88296,8 +87990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -88308,7 +88002,7 @@ paths: application/json: schema: type: array - items: *447 + items: *445 examples: default: *559 headers: @@ -88340,8 +88034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -88352,7 +88046,7 @@ paths: application/json: schema: type: array - items: *458 + items: *456 examples: default: value: @@ -88390,8 +88084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *318 - - *319 + - *314 + - *315 - *557 responses: '204': @@ -88415,8 +88109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -88529,8 +88223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 responses: '200': @@ -88606,8 +88300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -88645,7 +88339,7 @@ paths: description: Response content: application/json: - schema: *451 + schema: *449 examples: default: value: @@ -89181,8 +88875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: true @@ -89217,7 +88911,7 @@ paths: description: Response content: application/json: - schema: *451 + schema: *449 examples: default: value: @@ -89722,8 +89416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *17 - *19 @@ -89890,8 +89584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -90047,8 +89741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - &561 name: review_id @@ -90123,8 +89817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90211,8 +89905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 responses: @@ -90249,8 +89943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 - *17 @@ -90510,8 +90204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90605,8 +90299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *318 - - *319 + - *314 + - *315 - *557 - *561 requestBody: @@ -90667,8 +90361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *318 - - *319 + - *314 + - *315 - *557 requestBody: required: false @@ -90733,8 +90427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *318 - - *319 + - *314 + - *315 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -90791,8 +90485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *318 - - *319 + - *314 + - *315 - name: dir description: The alternate path to look for a README file in: path @@ -90836,8 +90530,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -90941,8 +90635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -91125,8 +90819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - &568 name: asset_id description: The unique identifier of the asset. @@ -91176,7 +90870,7 @@ paths: type: User site_admin: false '404': *6 - '302': *460 + '302': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91192,8 +90886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - *568 requestBody: required: false @@ -91241,8 +90935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *318 - - *319 + - *314 + - *315 - *568 responses: '204': @@ -91267,8 +90961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -91354,8 +91048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -91380,8 +91074,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *318 - - *319 + - *314 + - *315 - name: tag description: tag parameter in: path @@ -91418,8 +91112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *318 - - *319 + - *314 + - *315 - &571 name: release_id description: The unique identifier of the release. @@ -91454,8 +91148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 requestBody: required: false @@ -91543,8 +91237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 responses: '204': @@ -91565,8 +91259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *318 - - *319 + - *314 + - *315 - *571 - *17 - *19 @@ -91658,8 +91352,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: - - *318 - - *319 + - *314 + - *315 - *571 - name: name in: query @@ -91741,8 +91435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -91767,9 +91461,9 @@ paths: application/json: schema: type: array - items: *313 + items: *443 examples: - default: *315 + default: *512 headers: Link: *56 '404': *6 @@ -91790,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *318 - - *319 + - *314 + - *315 - *571 requestBody: required: true @@ -91822,16 +91516,16 @@ paths: description: Reaction exists content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '201': description: Reaction created content: application/json: - schema: *313 + schema: *443 examples: - default: *314 + default: *444 '422': *15 x-github: githubCloudOnly: false @@ -91853,10 +91547,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *318 - - *319 + - *314 + - *315 - *571 - - *316 + - *513 responses: '204': description: Response @@ -91880,9 +91574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *318 - - *319 - - *385 + - *314 + - *315 + - *381 - *17 - *19 responses: @@ -92019,8 +91713,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - name: includes_parents @@ -92086,8 +91780,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 requestBody: description: Request body required: true @@ -92196,8 +91890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *318 - - *319 + - *314 + - *315 - *576 - *577 - *578 @@ -92232,8 +91926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *318 - - *319 + - *314 + - *315 - *582 responses: '200': @@ -92270,8 +91964,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92311,8 +92005,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92394,8 +92088,8 @@ paths: category: repos subcategory: rules parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92418,8 +92112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 - name: ruleset_id @@ -92456,8 +92150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *318 - - *319 + - *314 + - *315 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92530,8 +92224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 - *588 - *589 - *590 @@ -92809,9 +92503,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *598 responses: '200': @@ -92872,9 +92566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 requestBody: required: true content: @@ -93014,9 +92708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *318 - - *319 - - *415 + - *314 + - *315 + - *411 - *19 - *17 responses: @@ -93152,8 +92846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -93232,8 +92926,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: - - *318 - - *319 + - *314 + - *315 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -93354,8 +93048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *318 - - *319 + - *314 + - *315 - *50 - name: sort description: The property to sort the results by. @@ -93424,8 +93118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -93830,8 +93524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -94091,8 +93785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 - *621 responses: '200': @@ -94125,8 +93819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *318 - - *319 + - *314 + - *315 - *621 requestBody: required: true @@ -94339,8 +94033,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: - - *318 - - *319 + - *314 + - *315 - *621 responses: '202': *37 @@ -94368,17 +94062,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *318 - - *319 + - *314 + - *315 - *621 responses: '202': description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 '400': *14 '422': *15 '403': *27 @@ -94404,8 +94098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -94501,8 +94195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -94544,8 +94238,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -94623,8 +94317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -94718,8 +94412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -94873,8 +94567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -94917,8 +94611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *318 - - *319 + - *314 + - *315 - name: sha in: path required: true @@ -95028,8 +94722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95061,8 +94755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: if you subscribe to the repository @@ -95141,8 +94835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -95195,8 +94889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -95216,8 +94910,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95299,8 +94993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95365,8 +95059,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: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -95420,8 +95114,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: - - *318 - - *319 + - *314 + - *315 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -95458,8 +95152,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *318 - - *319 + - *314 + - *315 - name: ref in: path required: true @@ -95495,8 +95189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *318 - - *319 + - *314 + - *315 - *17 - *19 responses: @@ -95528,8 +95222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *318 - - *319 + - *314 + - *315 - *19 - *17 responses: @@ -95572,8 +95266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -95627,8 +95321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *318 - - *319 + - *314 + - *315 - &629 name: per description: The time frame to display results for. @@ -95748,8 +95442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95844,8 +95538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *318 - - *319 + - *314 + - *315 responses: '200': description: Response @@ -95909,8 +95603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *318 - - *319 + - *314 + - *315 - *629 responses: '200': @@ -96010,8 +95704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *318 - - *319 + - *314 + - *315 requestBody: required: true content: @@ -96285,8 +95979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -96309,8 +96003,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -96332,8 +96026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -96359,8 +96053,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *318 - - *319 + - *314 + - *315 - name: ref in: path required: true @@ -96452,9 +96146,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -96935,7 +96629,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 comment_count: type: integer message: @@ -96954,7 +96648,7 @@ paths: url: type: string format: uri - verification: *497 + verification: *495 required: - author - committer @@ -96969,7 +96663,7 @@ paths: committer: anyOf: - type: 'null' - - *383 + - *379 parents: type: array items: @@ -99178,246 +98872,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: - - *636 - - *309 - - *312 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *636 - - *309 - - *312 - 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: *313 - examples: - default: *314 - 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: - - *636 - - *309 - - 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: *313 - examples: - default: *315 - headers: - Link: *56 - 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: - - *636 - - *309 - 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: *313 - examples: - default: *314 - 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) @@ -99643,7 +99097,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-user-is-a-team-maintainer: *641 '404': *6 @@ -99704,7 +99158,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *313 examples: response-if-users-membership-with-team-is-now-pending: *642 '403': @@ -99811,8 +99265,8 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 responses: '200': description: Alternative response with extra repository information @@ -99970,8 +99424,8 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 requestBody: required: false content: @@ -100022,8 +99476,8 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *636 - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -100849,7 +100303,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -100857,7 +100311,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -100943,7 +100397,7 @@ paths: - visibility - selected_repositories_url examples: - default: *440 + default: *436 headers: Link: *56 x-github: @@ -101319,7 +100773,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '304': *35 '500': *104 '401': *23 @@ -101377,7 +100831,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '401': *23 '403': *27 '404': *6 @@ -101571,7 +101025,7 @@ paths: type: integer machines: type: array - items: *439 + items: *435 examples: default: *651 '304': *35 @@ -101658,11 +101112,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *321 + repository: *317 machine: anyOf: - type: 'null' - - *439 + - *435 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -102467,7 +101921,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '304': *35 '500': *104 '400': *14 @@ -102507,7 +101961,7 @@ paths: application/json: schema: *221 examples: - default: *438 + default: *434 '500': *104 '401': *23 '403': *27 @@ -103678,7 +103132,7 @@ paths: required: true content: application/json: - schema: *508 + schema: *506 examples: default: value: @@ -106143,9 +105597,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *317 examples: - default: *323 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106183,7 +105637,7 @@ paths: application/json: schema: type: array - items: *510 + items: *508 examples: default: *665 headers: @@ -106802,8 +106256,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: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response if this repository is starred by you @@ -106831,8 +106285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -106856,8 +106310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *318 - - *319 + - *314 + - *315 responses: '204': description: Response @@ -107538,7 +106992,7 @@ paths: initiator: type: string examples: - default: *379 + default: *375 '201': description: Response content: @@ -108069,7 +107523,7 @@ paths: application/json: schema: *20 examples: - default: *507 + default: *505 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115568,7 +115022,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115900,7 +115354,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -116244,7 +115698,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116603,7 +116057,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -116886,7 +116340,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117184,7 +116638,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117505,7 +116959,7 @@ webhooks: required: - login - id - dismissed_comment: *410 + dismissed_comment: *406 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118617,7 +118071,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118705,7 +118159,7 @@ webhooks: type: string enum: - auto_reopened - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118793,7 +118247,7 @@ webhooks: type: string enum: - created - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118879,7 +118333,7 @@ webhooks: type: string enum: - dismissed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -118965,7 +118419,7 @@ webhooks: type: string enum: - fixed - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -119052,7 +118506,7 @@ webhooks: type: string enum: - reintroduced - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -119138,7 +118592,7 @@ webhooks: type: string enum: - reopened - alert: *466 + alert: *464 installation: *700 organization: *701 enterprise: *699 @@ -120656,7 +120110,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *472 + deployment: *470 pull_requests: type: array items: *555 @@ -151078,7 +150532,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *399 + head_commit: *395 required: - head_sha - head_ref @@ -225248,7 +224702,7 @@ webhooks: enterprise: *699 installation: *700 organization: *701 - repository: *321 + repository: *317 sender: *4 required: - changes @@ -230578,7 +230032,7 @@ webhooks: type: string required: - conclusion - deployment: *472 + deployment: *470 required: - action - repository @@ -230942,7 +230396,7 @@ webhooks: required: - status - steps - deployment: *472 + deployment: *470 required: - action - repository @@ -231170,7 +230624,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *472 + deployment: *470 required: - action - repository @@ -231399,7 +230853,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *472 + deployment: *470 required: - action - repository diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 67e39e154..e673fc5d8 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -287743,17 +287743,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": [ { @@ -287773,42 +287773,406 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + } + }, + "patch": { + "summary": "Update the connection between an external group and a team", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/link-external-idp-group-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group_id": { + "type": "integer", + "description": "External Group Id", + "examples": [ + 1 + ] + } + }, + "required": [ + "group_id" + ] + }, + "examples": { + "default": { + "value": { + "group_id": 123 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" + } + }, + "delete": { + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/unlink-external-idp-group-from-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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" + } + } + ], + "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": "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, + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "type": "string" } }, { @@ -287838,228 +288202,244 @@ "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", - "examples": [ - 1 + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" + "email": { + "type": [ + "string", + "null" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -288068,29 +288448,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" } ] } @@ -288110,20 +288497,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/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.", + } + }, + "/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/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" }, "parameters": [ { @@ -288145,296 +288534,219 @@ } }, { - "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/enterprise-cloud@latest//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/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" - } - } - } + }, + { + "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 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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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=", @@ -288453,297 +288765,146 @@ "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/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" } }, - "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", - "examples": [ - 1 - ] - }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "format": "uri" }, - "content": { - "description": "The reaction to use", - "type": "string", + "role": { + "description": "The role of the user in the team.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "member", + "maintainer" ], + "default": "member", + "type": "string", "examples": [ - "heart" + "member" ] }, - "created_at": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "enum": [ + "active", + "pending" ] } }, "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/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.", + }, + "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": [ - "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/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -288765,57 +288926,179 @@ } }, { - "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", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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/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 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/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -288836,34 +289119,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).\"", @@ -288891,228 +289146,869 @@ "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", + "format": "int64", "examples": [ - 1 + 1296269 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -289120,9 +290016,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=", @@ -289142,8 +290040,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_validity_checks": { + "status": "disabled" + } + } } ] } @@ -289163,20 +290151,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/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}/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-cloud@latest//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/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -289198,336 +290188,157 @@ } }, { - "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/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": "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": { + "description": "Unique identifier of the repository", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "key": { "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "mit" ] }, - "node_id": { + "name": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MIT License" ] }, - "avatar_url": { - "type": "string", + "url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/licenses/mit" ] }, - "gravatar_id": { + "spdx_id": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MIT" ] }, - "url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "format": "uri" } }, "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" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] + "forks": { + "type": "integer" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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 + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "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", - "examples": [ - 1 + "required": [ + "admin", + "pull", + "push" ] }, - "node_id": { + "role_name": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "admin" ] }, - "user": { + "owner": { "anyOf": [ { "type": "null" @@ -289702,45 +290513,606 @@ } ] }, - "content": { - "description": "The reaction to use", + "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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + 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", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + 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", - "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", + "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": { - "default": { + "alternative-response-with-repository-permissions": { "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=", @@ -289760,34 +291132,135 @@ "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, + "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": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" } - } - }, - "/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.", + }, + "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-cloud@latest//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-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/add-or-update-repo-permissions-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/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -289809,48 +291282,133 @@ } }, { - "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" } } ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { + "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": "reactions", - "subcategory": "reactions" + "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/enterprise-cloud@latest//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}/external-groups": { + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { "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.", + "summary": "List IdP groups for a team", + "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\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> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", + "operationId": "teams/list-idp-groups-in-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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team" }, "parameters": [ { @@ -289878,38 +291436,55 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", + "title": "GroupMapping", + "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { - "description": "An array of external groups available to be mapped to a team", + "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", - "updated_at" + "group_description" ], "properties": { "group_id": { - "description": "The internal ID of the group", - "type": "integer", + "description": "The ID of the group", + "type": "string", "examples": [ - 1 + "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { - "description": "The display name of the group", + "description": "The name of the group", "type": "string", "examples": [ - "group-azuread-test" + "saml-azuread-test" ] }, - "updated_at": { - "description": "The time of the last update for this group", + "group_description": { + "description": "a description of the group", + "type": "string", + "examples": [ + "A group of Developers working on AzureAD SAML SSO" + ] + }, + "status": { + "description": "synchronization status for this group mapping", "type": "string", + "examples": [ + "unsynced" + ] + }, + "synced_at": { + "description": "the time of the last sync for this group-mapping", + "type": [ + "string", + "null" + ], "examples": [ "2019-06-03 22:27:15:000 -700" ] @@ -289918,14 +291493,14 @@ }, "examples": [ { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" + "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "group_name": "saml-azuread-test", + "group_description": "A group of Developers working on AzureAD SAML SSO" }, { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" + "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + "group_name": "saml-azuread-test2", + "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } @@ -289938,12 +291513,12 @@ { "group_id": "123", "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" + "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" + "group_description": "The people who make your octoworld come to life." } ] } @@ -289955,21 +291530,21 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "category": "teams", - "subcategory": "external-groups" + "subcategory": "team-sync" } }, "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.", + "summary": "Create or update IdP group connections", + "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for 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> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], - "operationId": "teams/link-external-idp-group-to-team-for-org", + "operationId": "teams/create-or-update-idp-group-connections-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/team-sync#create-or-update-idp-group-connections" }, "parameters": [ { @@ -289998,22 +291573,45 @@ "schema": { "type": "object", "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "examples": [ - 1 - ] + "groups": { + "type": "array", + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", + "items": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "description": "ID of the IdP group." + }, + "group_name": { + "type": "string", + "description": "Name of the IdP group." + }, + "group_description": { + "type": "string", + "description": "Description of the IdP group." + } + }, + "required": [ + "group_id", + "group_name", + "group_description" + ] + } } }, - "required": [ - "group_id" - ] + "additionalProperties": false }, "examples": { "default": { "value": { - "group_id": 123 + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "string" + } + ] } } } @@ -290026,128 +291624,71 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", + "title": "GroupMapping", + "description": "External Groups to be mapped to a team for membership", "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", + "groups": { + "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ - "team_id", - "team_name" + "group_id", + "group_name", + "group_description" ], "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer", + "group_id": { + "description": "The ID of the group", + "type": "string", "examples": [ - 1 + "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, - "team_name": { - "description": "The name of the team", + "group_name": { + "description": "The name of the group", "type": "string", "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 + "saml-azuread-test" ] }, - "member_login": { - "description": "The handle/login for the user", + "group_description": { + "description": "a description of the group", "type": "string", "examples": [ - "mona-lisa_eocsaxrs" + "A group of Developers working on AzureAD SAML SSO" ] }, - "member_name": { - "description": "The user display name/profile name", + "status": { + "description": "synchronization status for this group mapping", "type": "string", "examples": [ - "Mona Lisa" + "unsynced" ] }, - "member_email": { - "description": "An email attached to a user", - "type": "string", + "synced_at": { + "description": "the time of the last sync for this group-mapping", + "type": [ + "string", + "null" + ], "examples": [ - "mona_lisa@github.com" + "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" + "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "group_name": "saml-azuread-test", + "group_description": "A group of Developers working on AzureAD SAML SSO" }, { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" + "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + "group_name": "saml-azuread-test2", + "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } @@ -290156,31 +291697,16 @@ "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": [ + "groups": [ { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "The people who configure your octoworld." }, { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" + "group_id": "456", + "group_name": "Octocat docs members", + "group_description": "The people who make your octoworld come to life." } ] } @@ -290194,64 +291720,21 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" + "subcategory": "team-sync" } } }, - "/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 Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "List 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/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -290293,288 +291776,298 @@ ], "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", - "null" - ] + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": [ "string", "null" ] }, - "failed_reason": { - "type": [ - "string", - "null" - ] + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "type": "boolean" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "team_count": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "node_id": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://github.com/orgs/rails/teams/core" ] }, - "invitation_teams_url": { + "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", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + 37 ] }, - "invitation_source": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "\"member\"" + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } ] } }, "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" } ] } @@ -290595,21 +292088,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/enterprise-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -290622,400 +292115,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" + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] } }, { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, + "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": [ - "member", - "maintainer", - "all" - ], - "default": "all" + "enable_all", + "disable_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 + } + ], + "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" }, - { - "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 - } + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + }, + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "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" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "core", + "search" + ] }, - "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" - ] - } + "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": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": { + "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": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "type": "string" + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } - } - }, - "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" - } + "304": { + "description": "Not modified" }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "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", - "type": "string", - "examples": [ - "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-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" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "404": { - "description": "if user has no team membership" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "rate-limit", + "subcategory": "rate-limit" } - }, - "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}`.", + } + }, + "/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/enterprise-cloud@latest//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/add-or-update-membership-for-user-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-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.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -291023,8 +292705,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -291032,4021 +292714,242 @@ } } ], - "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", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "default": "member", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "member" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "state": { - "description": "The state of the user's membership in the team.", + "archive_url": { "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if team synchronization is set up" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Alternative response with repository permissions", - "content": { - "application/json": { - "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - 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/enterprise-cloud@latest//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-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//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}/team-sync/group-mappings": { - "get": { - "summary": "List IdP groups for a team", - "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\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> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-idp-groups-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-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": "GroupMapping", - "description": "External Groups to be mapped to a team for membership", - "type": "object", - "properties": { - "groups": { - "description": "Array of groups to be mapped to this team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "group_description" - ], - "properties": { - "group_id": { - "description": "The ID of the group", - "type": "string", - "examples": [ - "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" - ] - }, - "group_name": { - "description": "The name of the group", - "type": "string", - "examples": [ - "saml-azuread-test" - ] - }, - "group_description": { - "description": "a description of the group", - "type": "string", - "examples": [ - "A group of Developers working on AzureAD SAML SSO" - ] - }, - "status": { - "description": "synchronization status for this group mapping", - "type": "string", - "examples": [ - "unsynced" - ] - }, - "synced_at": { - "description": "the time of the last sync for this group-mapping", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", - "group_name": "saml-azuread-test", - "group_description": "A group of Developers working on AzureAD SAML SSO" - }, - { - "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", - "group_name": "saml-azuread-test2", - "group_description": "Another group of Developers working on AzureAD SAML SSO" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "The people who configure your octoworld." - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "group_description": "The people who make your octoworld come to life." - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "team-sync" - } - }, - "patch": { - "summary": "Create or update IdP group connections", - "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for 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> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", - "tags": [ - "teams" - ], - "operationId": "teams/create-or-update-idp-group-connections-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections" - }, - "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": { - "groups": { - "type": "array", - "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "description": "ID of the IdP group." - }, - "group_name": { - "type": "string", - "description": "Name of the IdP group." - }, - "group_description": { - "type": "string", - "description": "Description of the IdP group." - } - }, - "required": [ - "group_id", - "group_name", - "group_description" - ] - } - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "string" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GroupMapping", - "description": "External Groups to be mapped to a team for membership", - "type": "object", - "properties": { - "groups": { - "description": "Array of groups to be mapped to this team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "group_description" - ], - "properties": { - "group_id": { - "description": "The ID of the group", - "type": "string", - "examples": [ - "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" - ] - }, - "group_name": { - "description": "The name of the group", - "type": "string", - "examples": [ - "saml-azuread-test" - ] - }, - "group_description": { - "description": "a description of the group", - "type": "string", - "examples": [ - "A group of Developers working on AzureAD SAML SSO" - ] - }, - "status": { - "description": "synchronization status for this group mapping", - "type": "string", - "examples": [ - "unsynced" - ] - }, - "synced_at": { - "description": "the time of the last sync for this group-mapping", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", - "group_name": "saml-azuread-test", - "group_description": "A group of Developers working on AzureAD SAML SSO" - }, - { - "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", - "group_name": "saml-azuread-test2", - "group_description": "Another group of Developers working on AzureAD SAML SSO" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "The people who configure your octoworld." - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "group_description": "The people who make your octoworld come to life." - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "team-sync" - } - } - }, - "/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/enterprise-cloud@latest//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/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": "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "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-cloud@latest//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-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "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" - ] - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { @@ -692411,1170 +690314,56 @@ "https://api.github.com/users/octocat/received_events" ] }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "fragment": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "draft": { - "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" + ] + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -693741,784 +690530,461 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { "type": "integer" }, - "watchers": { + "completed": { "type": "integer" }, - "master_branch": { - "type": "string" + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "blocking": { + "type": "integer" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "total_blocked_by": { + "type": "integer" }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "total_blocking": { + "type": "integer" } }, "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" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] }, - "body_html": { - "type": "string" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } }, - "body_text": { + "state": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "state_reason": { "type": [ - "object", + "string", "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } - }, - "required": [ - "id", - "node_id", - "name", - "description" ] }, - "performed_via_github_app": { + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 37 + 1002604 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "node_id": { + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "open" ] }, - "client_id": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "v1.0" ] }, - "owner": { - "oneOf": [ + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -694662,680 +691128,118 @@ "user_view_type": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 280, - "incomplete_results": false, - "items": [ - { - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", - "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", - "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", - "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", - "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", - "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", - "id": 35802, - "node_id": "MDU6SXNzdWUzNTgwMg==", - "number": 132, - "title": "Line Number Indexes Beyond 20 Not Displayed", - "user": { - "login": "Nick3C", - "id": 90254, - "node_id": "MDQ6VXNlcjkwMjU0", - "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/Nick3C", - "html_url": "https://github.com/Nick3C", - "followers_url": "https://api.github.com/users/Nick3C/followers", - "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", - "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", - "organizations_url": "https://api.github.com/users/Nick3C/orgs", - "repos_url": "https://api.github.com/users/Nick3C/repos", - "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", - "received_events_url": "https://api.github.com/users/Nick3C/received_events", - "type": "User", - "site_admin": true - }, - "labels": [ - { - "id": 4, - "node_id": "MDU6TGFiZWw0", - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", - "name": "bug", - "color": "ff0000" - } - ], - "state": "open", - "assignee": null, - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "comments": 15, - "created_at": "2009-07-12T20:10:41Z", - "updated_at": "2009-07-19T09:23:43Z", - "closed_at": null, - "pull_request": { - "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "body": "...", - "score": 1, - "locked": true, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ] - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/labels": { - "get": { - "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/labels", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "query", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ] - } - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Label Search Result Item", - "description": "Label Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" + "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" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "node_id": { - "type": "string" + "comments": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" + "format": "date-time" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "date-time" }, - "description": { + "closed_at": { "type": [ "string", "null" - ] - }, - "score": { - "type": "number" + ], + "format": "date-time" }, "text_matches": { "title": "Search Result Text Matches", @@ -695377,308 +691281,203 @@ } } } - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "incomplete_results": false, - "items": [ - { - "id": 418327088, - "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", - "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", - "name": "enhancement", - "color": "84b6eb", - "default": true, - "description": "New feature or request.", - "score": 1 - }, - { - "id": 418327086, - "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", - "url": "https://api.github.com/repos/octocat/linguist/labels/bug", - "name": "bug", - "color": "ee0701", - "default": true, - "description": "Something isn't working.", - "score": 1 - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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": [ - { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - { + "diff_url": { "type": [ - "integer", + "string", "null" - ] + ], + "format": "uri" }, - { + "html_url": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/repositories": { - "get": { - "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" - }, - "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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "stars", - "forks", - "help-wanted-issues", - "updated" - ] - } - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Repo Search Result Item", - "description": "Repo Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { + "body": { "type": "string" }, - "name": { - "type": "string" + "score": { + "type": "number" }, - "full_name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -695845,966 +691644,1223 @@ "type", "url" ] - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "score": { - "type": "number" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "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" - }, - "license": { - "anyOf": [ - { - "type": "null" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "maintain": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "push": { - "type": "boolean" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "triage": { - "type": "boolean" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 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", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "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", - "examples": [ - 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": [ - { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + 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", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - { + "created_at": { "type": [ - "integer", + "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - { + "updated_at": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "display_name": { - "type": [ - "string", - "null" - ] - }, - "short_description": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_by": { - "type": [ - "string", - "null" + }, + "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" ] }, - "released": { - "type": [ - "string", - "null" - ] + "body_html": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "body_text": { + "type": "string" }, - "updated_at": { + "timeline_url": { "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" + "format": "uri" }, - "repository_count": { + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "integer", + "object", "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { + "issues": { "type": "string" }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } - } - } - } - } - } - }, - "related": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "name": { + "additionalProperties": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } - } - } - } - } - }, - "aliases": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] } - } + ] + }, + "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": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", "updated_at", - "featured", - "curated", "score" ] } @@ -696814,436 +692870,103 @@ "examples": { "default": { "value": { - "total_count": 6, + "total_count": 280, "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//graphql/reference/queries#search).\"", - "tags": [ - "search" - ], - "operationId": "search/users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "User Search Result Item", - "description": "User Search Result Item", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "score": { - "type": "number" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, - "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", + "body": "...", "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 + "locked": true, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -697252,9 +692975,6 @@ } } }, - "304": { - "description": "Not modified" - }, "503": { "description": "Service unavailable", "content": { @@ -697350,6 +693070,35 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { @@ -697360,27 +693109,81 @@ } } }, - "/teams/{team_id}": { + "/search/labels": { "get": { - "summary": "Get a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/get-legacy", + "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", "required": true, "schema": { "type": "integer" } + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + } + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -697389,753 +693192,146 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "node_id": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "score": { + "type": "number" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + } } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -698161,1794 +693357,1821 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", - "tags": [ - "teams" - ], - "operationId": "teams/update-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] + "type": "string" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "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" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "documentation_url": { + "type": "string" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "field": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" + }, + "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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + } + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "pushed_at": { + "type": "string", + "format": "date-time" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "score": { + "type": "number" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "topics": { + "type": "array", + "items": { "type": "string" + } + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "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" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "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": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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", + "examples": [ + false + ] + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] + "required": [ + "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": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { + } + } + } + } + } + }, + "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" }, - "status": { + "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "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/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Topic Search Result Item", + "description": "Topic Search Result Item", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": [ + "string", + "null" + ] + }, + "short_description": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "created_by": { + "type": [ + "string", + "null" + ] + }, + "released": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + "logo_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "related": { + "type": [ + "array", + "null" + ], + "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", + "null" + ], + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//graphql/reference/queries#search).\"", + "tags": [ + "search" + ], + "operationId": "search/users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "incomplete_results", + "items" ], "properties": { - "message": { - "type": "string" + "total_count": { + "type": "integer" }, - "documentation_url": { - "type": "string" + "incomplete_results": { + "type": "boolean" }, - "errors": { + "items": { "type": "array", "items": { + "title": "User Search Result Item", + "description": "User Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "login": { "type": "string" }, - "field": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string" }, - "message": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, - "code": { + "score": { + "type": "number" + }, + "following_url": { "type": "string" }, - "index": { + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "public_repos": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "site_admin": { + "type": "boolean" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } + } + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -700035,25 +695258,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true + "category": "search", + "subcategory": "search" + } } }, - "/teams/{team_id}/discussions": { + "/teams/{team_id}": { "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "Get a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -700064,38 +695284,6 @@ "schema": { "type": "integer" } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -700104,545 +695292,115 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], - "operationId": "teams/get-discussion-legacy", + "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -701057,548 +696096,941 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + 1 + ] + }, + "node_id": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

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

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -702308,11 +698208,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -702322,45 +698235,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -702418,12 +698352,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" ] @@ -702453,19 +698392,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, @@ -702498,20 +698442,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": [ { @@ -702522,15 +698466,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -702540,19 +698475,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." } } } @@ -702565,8 +698511,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": { @@ -702745,16 +698691,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -702764,11 +698710,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -702778,45 +698737,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -702874,12 +698854,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" ] @@ -702907,19 +698892,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, @@ -702944,22 +698934,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": [ { @@ -702979,15 +698969,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -702996,8 +698977,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": { @@ -703176,16 +699157,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -703195,11 +699176,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -703209,45 +699203,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -703305,12 +699320,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" ] @@ -703338,19 +699358,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, @@ -703374,20 +699399,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": [ { @@ -703407,37 +699432,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" } } } @@ -703450,8 +699467,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": { @@ -703630,16 +699647,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -703649,11 +699666,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -703663,45 +699693,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -703759,12 +699810,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" ] @@ -703792,19 +699848,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, @@ -703828,20 +699889,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": [ { @@ -703861,15 +699922,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -703883,22 +699935,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": [ { @@ -703920,31 +699972,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" } }, { @@ -703974,23 +700012,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -704165,104 +700191,678 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" + "eyes", + "rocket" ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + } + } + } + }, + "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": "discussion-comments" + }, + "deprecated": true + }, + "post": { + "summary": "Create a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/create-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy" + }, + "parameters": [ + { + "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": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like apples?" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "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": { + "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 - }, - "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.", + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/get-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#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -704293,65 +700893,17 @@ } } ], - "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": { + "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -704526,45 +701078,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -704584,8 +701241,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 + } } } } @@ -704596,25 +701274,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 - } - }, - "/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.", + }, + "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/list-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#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -704636,354 +701312,8 @@ } }, { - "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", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - ] - } - } - } - }, - "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" - }, - "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": [ - { - "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.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -704998,29 +701328,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?" } } } @@ -705028,28 +701348,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -705224,45 +701532,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -705282,8 +701695,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 + } } } } @@ -705293,11 +701727,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-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b60759a91..af0c57cf6 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -13533,7 +13533,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &521 + instances_url: &517 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13569,7 +13569,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &522 + dismissed_reason: &518 type: - string - 'null' @@ -13580,14 +13580,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &523 + dismissed_comment: &519 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &524 + rule: &520 type: object properties: id: @@ -13648,7 +13648,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &525 + tool: &521 type: object properties: name: *109 @@ -13659,26 +13659,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &526 + most_recent_instance: &522 type: object properties: - ref: &519 + ref: &515 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &536 + analysis_key: &532 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: &537 + environment: &533 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: &538 + category: &534 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13692,7 +13692,7 @@ paths: properties: text: type: string - location: &539 + location: &535 type: object description: Describe a region within a file for the alert. properties: @@ -13713,7 +13713,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &540 + items: &536 type: - string - 'null' @@ -17487,7 +17487,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &575 + - &573 name: has in: query description: |- @@ -17604,7 +17604,7 @@ paths: - direct - transitive - - security_advisory: &576 + security_advisory: &574 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17840,7 +17840,7 @@ paths: dismissal. maxLength: 280 fixed_at: *133 - auto_dismissed_at: &577 + auto_dismissed_at: &575 type: - string - 'null' @@ -17848,7 +17848,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &578 + dismissal_request: &576 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -26631,7 +26631,7 @@ paths: action: type: string issue: *212 - comment: &635 + comment: &633 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -31384,14 +31384,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &448 + - &444 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &449 + - &445 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -31453,7 +31453,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &454 + '301': &450 description: Moved permanently content: application/json: @@ -34107,7 +34107,7 @@ paths: type: integer repository_cache_usages: type: array - items: &461 + items: &457 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -37274,7 +37274,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &477 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -37309,7 +37309,7 @@ paths: - key_id - key examples: - default: &482 + default: &478 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37722,7 +37722,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *85 - - &466 + - &462 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)." @@ -39368,7 +39368,7 @@ paths: initiator: type: string examples: - default: &495 + default: &491 value: attestations: - bundle: @@ -40290,7 +40290,7 @@ paths: be returned. in: query required: false - schema: &520 + schema: &516 type: string description: Severity of a code scanning alert. enum: @@ -41349,7 +41349,7 @@ paths: machine: anyOf: - type: 'null' - - &552 + - &548 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -42301,7 +42301,7 @@ paths: - updated_at - visibility examples: - default: &553 + default: &549 value: total_count: 2 secrets: @@ -42339,7 +42339,7 @@ paths: description: Response content: application/json: - schema: &554 + schema: &550 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -42374,7 +42374,7 @@ paths: - key_id - key examples: - default: &555 + default: &551 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42406,7 +42406,7 @@ paths: application/json: schema: *316 examples: - default: &557 + default: &553 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44285,7 +44285,7 @@ paths: description: Response content: application/json: - schema: &581 + schema: &579 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -44304,7 +44304,7 @@ paths: - key_id - key examples: - default: &582 + default: &580 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44634,7 +44634,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *85 - - &590 + - &588 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -44642,7 +44642,7 @@ paths: required: false schema: type: string - - &591 + - &589 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -44650,7 +44650,7 @@ paths: required: false schema: type: string - - &592 + - &590 name: time_period description: |- The time period to filter by. @@ -44666,7 +44666,7 @@ paths: - week - month default: month - - &593 + - &591 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -44691,7 +44691,7 @@ paths: application/json: schema: type: array - items: &594 + items: &592 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -44854,7 +44854,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &595 + default: &593 value: - id: 21 number: 42 @@ -44972,7 +44972,7 @@ paths: application/json: schema: type: array - items: &596 + items: &594 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -45095,7 +45095,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &597 + default: &595 value: - id: 21 number: 42 @@ -45197,7 +45197,7 @@ paths: application/json: schema: type: array - items: &598 + items: &596 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -45324,7 +45324,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &599 + default: &597 value: - id: 21 number: 42 @@ -45670,7 +45670,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &441 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -45760,7 +45760,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &446 + default: &442 value: group_id: '123' group_name: Octocat admins @@ -45815,7 +45815,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &439 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -45855,7 +45855,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &444 + default: &440 value: groups: - group_id: '123' @@ -47184,7 +47184,7 @@ paths: application/json: schema: *20 examples: - default: &630 + default: &628 value: id: 1 account: @@ -47412,7 +47412,7 @@ paths: required: true content: application/json: - schema: &631 + schema: &629 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -48280,7 +48280,7 @@ paths: application/json: schema: *363 examples: - default: &551 + default: &547 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -53029,7 +53029,7 @@ paths: content: oneOf: - *212 - - &564 + - &562 title: Pull Request Simple description: Pull Request Simple type: object @@ -55936,7 +55936,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &449 title: Full Repository description: Full Repository type: object @@ -56401,7 +56401,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &569 + code_of_conduct: &567 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -56515,7 +56515,7 @@ paths: - network_count - subscribers_count examples: - default: &455 + default: &451 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -59431,7 +59431,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &446 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -59483,7 +59483,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &451 + default: &447 value: groups: - group_id: '123' @@ -61185,408 +61185,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: - - *85 - - *209 - - *435 - - *438 - - 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: &439 - 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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - *4 - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &441 - 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: *45 - 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: - - *85 - - *209 - - *435 - - *438 - 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: *439 - examples: - default: &440 - 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: *439 - examples: - default: *440 - 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: - - *85 - - *209 - - *435 - - *438 - - &442 - 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: - - *85 - - *209 - - *435 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *85 - - *209 - - *435 - 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: *439 - examples: - default: *440 - '201': - description: Response - content: - application/json: - schema: *439 - examples: - default: *440 - 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: - - *85 - - *209 - - *435 - - *442 - 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 @@ -61608,9 +61206,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *439 examples: - default: *444 + default: *440 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -61654,9 +61252,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *441 examples: - default: *446 + default: *442 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61797,7 +61395,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &443 title: Team Membership description: Team Membership type: object @@ -61888,7 +61486,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-users-membership-with-team-is-now-pending: &779 summary: Response if user's membership with team is now pending @@ -61997,8 +61595,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Alternative response with repository permissions @@ -62647,8 +62245,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -62695,8 +62293,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -62729,9 +62327,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: - default: *451 + default: *447 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62797,7 +62395,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: default: value: @@ -62996,7 +62594,7 @@ paths: resources: type: object properties: - core: &452 + core: &448 title: Rate Limit type: object properties: @@ -63013,21 +62611,21 @@ paths: - remaining - reset - used - graphql: *452 - search: *452 - code_search: *452 - source_import: *452 - integration_manifest: *452 - code_scanning_upload: *452 - actions_runner_registration: *452 - scim: *452 - dependency_snapshots: *452 - dependency_sbom: *452 - code_scanning_autofix: *452 + graphql: *448 + search: *448 + code_search: *448 + source_import: *448 + integration_manifest: *448 + code_scanning_upload: *448 + actions_runner_registration: *448 + scim: *448 + dependency_snapshots: *448 + dependency_sbom: *448 + code_scanning_autofix: *448 required: - core - search - rate: *452 + rate: *448 required: - rate - resources @@ -63132,14 +62730,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *453 + schema: *449 examples: default-response: summary: Default response @@ -63644,7 +63242,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *454 + '301': *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63662,8 +63260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -63921,10 +63519,10 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 - '307': &456 + default: *451 + '307': &452 description: Temporary Redirect content: application/json: @@ -63953,8 +63551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -63976,7 +63574,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': *456 + '307': *452 '404': *6 '409': *116 x-github: @@ -64000,11 +63598,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - - &473 + - &469 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -64027,7 +63625,7 @@ paths: type: integer artifacts: type: array - items: &457 + items: &453 title: Artifact description: An artifact type: object @@ -64122,7 +63720,7 @@ paths: - expires_at - updated_at examples: - default: &474 + default: &470 value: total_count: 2 artifacts: @@ -64183,9 +63781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *448 - - *449 - - &458 + - *444 + - *445 + - &454 name: artifact_id description: The unique identifier of the artifact. in: path @@ -64197,7 +63795,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *453 examples: default: value: @@ -64235,9 +63833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *448 - - *449 - - *458 + - *444 + - *445 + - *454 responses: '204': description: Response @@ -64261,9 +63859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *448 - - *449 - - *458 + - *444 + - *445 + - *454 - name: archive_format in: path required: true @@ -64277,7 +63875,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': &634 + '410': &632 description: Gone content: application/json: @@ -64302,14 +63900,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &459 + schema: &455 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -64343,13 +63941,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *459 + schema: *455 examples: selected_actions: *42 responses: @@ -64378,14 +63976,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &460 + schema: &456 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -64419,13 +64017,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *460 + schema: *456 examples: selected_actions: *44 responses: @@ -64456,14 +64054,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *461 + schema: *457 examples: default: value: @@ -64489,11 +64087,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: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - - &462 + - &458 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 @@ -64527,7 +64125,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &459 title: Repository actions caches description: Repository actions caches type: object @@ -64577,7 +64175,7 @@ paths: - total_count - actions_caches examples: - default: &464 + default: &460 value: total_count: 1 actions_caches: @@ -64609,23 +64207,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: - - *448 - - *449 + - *444 + - *445 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *462 + - *458 responses: '200': description: Response content: application/json: - schema: *463 + schema: *459 examples: - default: *464 + default: *460 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64645,8 +64243,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: - - *448 - - *449 + - *444 + - *445 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -64677,9 +64275,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: - - *448 - - *449 - - &465 + - *444 + - *445 + - &461 name: job_id description: The unique identifier of the job. in: path @@ -64691,7 +64289,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &473 title: Job description: Information of a job execution in a workflow run type: object @@ -65038,9 +64636,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: - - *448 - - *449 - - *465 + - *444 + - *445 + - *461 responses: '302': description: Response @@ -65068,9 +64666,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: - - *448 - - *449 - - *465 + - *444 + - *445 + - *461 requestBody: required: false content: @@ -65116,8 +64714,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Status response @@ -65167,8 +64765,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -65231,8 +64829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -65250,7 +64848,7 @@ paths: type: integer secrets: type: array - items: &479 + items: &475 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -65271,7 +64869,7 @@ paths: - created_at - updated_at examples: - default: &480 + default: &476 value: total_count: 2 secrets: @@ -65304,9 +64902,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *448 - - *449 - - *466 + - *444 + - *445 + - *462 - *19 responses: '200': @@ -65323,7 +64921,7 @@ paths: type: integer variables: type: array - items: &483 + items: &479 title: Actions Variable type: object properties: @@ -65357,7 +64955,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &480 value: total_count: 2 variables: @@ -65390,8 +64988,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65400,7 +64998,7 @@ paths: schema: type: object properties: - enabled: &467 + enabled: &463 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *58 @@ -65435,8 +65033,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65447,7 +65045,7 @@ paths: schema: type: object properties: - enabled: *467 + enabled: *463 allowed_actions: *58 sha_pinning_required: *59 required: @@ -65480,14 +65078,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &468 + schema: &464 type: object properties: access_level: @@ -65505,7 +65103,7 @@ paths: required: - access_level examples: - default: &469 + default: &465 value: access_level: organization x-github: @@ -65530,15 +65128,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 responses: '204': description: Response @@ -65562,8 +65160,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65593,8 +65191,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Empty response for successful settings update @@ -65628,8 +65226,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65656,8 +65254,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65691,8 +65289,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65720,8 +65318,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -65752,8 +65350,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65784,8 +65382,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65817,8 +65415,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65847,8 +65445,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Success response @@ -65888,8 +65486,8 @@ paths: in: query schema: type: string - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -65933,8 +65531,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65966,8 +65564,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -66041,8 +65639,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: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -66078,8 +65676,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: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -66109,8 +65707,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': @@ -66140,8 +65738,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '204': @@ -66168,8 +65766,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': *79 @@ -66194,8 +65792,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: - - *448 - - *449 + - *444 + - *445 - *73 requestBody: required: true @@ -66244,8 +65842,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: - - *448 - - *449 + - *444 + - *445 - *73 requestBody: required: true @@ -66295,8 +65893,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': *279 @@ -66326,8 +65924,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: - - *448 - - *449 + - *444 + - *445 - *73 - *280 responses: @@ -66357,9 +65955,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: - - *448 - - *449 - - &487 + - *444 + - *445 + - &483 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. @@ -66367,7 +65965,7 @@ paths: required: false schema: type: string - - &488 + - &484 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -66375,7 +65973,7 @@ paths: required: false schema: type: string - - &489 + - &485 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -66384,7 +65982,7 @@ paths: required: false schema: type: string - - &490 + - &486 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 @@ -66411,7 +66009,7 @@ paths: - pending - *17 - *19 - - &491 + - &487 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)." @@ -66420,7 +66018,7 @@ paths: schema: type: string format: date-time - - &470 + - &466 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -66429,13 +66027,13 @@ paths: schema: type: boolean default: false - - &492 + - &488 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &493 + - &489 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -66458,7 +66056,7 @@ paths: type: integer workflow_runs: type: array - items: &471 + items: &467 title: Workflow Run description: An invocation of a workflow type: object @@ -66636,7 +66234,7 @@ paths: head_commit: anyOf: - type: 'null' - - &515 + - &511 title: Simple Commit description: A commit. type: object @@ -66751,7 +66349,7 @@ paths: - workflow_url - pull_requests examples: - default: &494 + default: &490 value: total_count: 1 workflow_runs: @@ -66987,24 +66585,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *448 - - *449 - - &472 + - *444 + - *445 + - &468 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *470 + - *466 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: &475 + default: &471 value: id: 30433642 name: Build @@ -67245,9 +66843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '204': description: Response @@ -67270,9 +66868,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -67400,9 +66998,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '201': description: Response @@ -67435,12 +67033,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 - *17 - *19 - - *473 + - *469 responses: '200': description: Response @@ -67456,9 +67054,9 @@ paths: type: integer artifacts: type: array - items: *457 + items: *453 examples: - default: *474 + default: *470 headers: Link: *45 x-github: @@ -67482,25 +67080,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *448 - - *449 - - *472 - - &476 + - *444 + - *445 + - *468 + - &472 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *470 + - *466 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *475 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67523,10 +67121,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: - - *448 - - *449 + - *444 + - *445 + - *468 - *472 - - *476 - *17 - *19 responses: @@ -67544,9 +67142,9 @@ paths: type: integer jobs: type: array - items: *477 + items: *473 examples: - default: &478 + default: &474 value: total_count: 1 jobs: @@ -67659,10 +67257,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *448 - - *449 + - *444 + - *445 + - *468 - *472 - - *476 responses: '302': description: Response @@ -67690,9 +67288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '202': description: Response @@ -67725,9 +67323,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: true content: @@ -67794,9 +67392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '202': description: Response @@ -67829,9 +67427,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 - 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 @@ -67861,9 +67459,9 @@ paths: type: integer jobs: type: array - items: *477 + items: *473 examples: - default: *478 + default: *474 headers: Link: *45 x-github: @@ -67888,9 +67486,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '302': description: Response @@ -67917,9 +67515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '204': description: Response @@ -67946,9 +67544,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -68017,7 +67615,7 @@ paths: items: type: object properties: - type: &600 + type: &598 type: string description: The type of reviewer. enum: @@ -68103,9 +67701,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: true content: @@ -68155,7 +67753,7 @@ paths: application/json: schema: type: array - items: &585 + items: &583 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -68267,7 +67865,7 @@ paths: - created_at - updated_at examples: - default: &586 + default: &584 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -68323,9 +67921,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: false content: @@ -68370,9 +67968,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: false content: @@ -68427,9 +68025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -68566,8 +68164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -68585,9 +68183,9 @@ paths: type: integer secrets: type: array - items: *479 + items: *475 examples: - default: *480 + default: *476 headers: Link: *45 x-github: @@ -68612,16 +68210,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68643,17 +68241,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: - default: &613 + default: &611 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -68679,8 +68277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -68738,8 +68336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -68765,9 +68363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *448 - - *449 - - *466 + - *444 + - *445 + - *462 - *19 responses: '200': @@ -68784,9 +68382,9 @@ paths: type: integer variables: type: array - items: *483 + items: *479 examples: - default: *484 + default: *480 headers: Link: *45 x-github: @@ -68809,8 +68407,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -68862,17 +68460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *479 examples: - default: &614 + default: &612 value: name: USERNAME value: octocat @@ -68898,8 +68496,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 requestBody: required: true @@ -68942,8 +68540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 responses: '204': @@ -68969,8 +68567,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -68988,7 +68586,7 @@ paths: type: integer workflows: type: array - items: &485 + items: &481 title: Workflow description: A GitHub Actions workflow type: object @@ -69106,9 +68704,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *448 - - *449 - - &486 + - *444 + - *445 + - &482 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -69123,7 +68721,7 @@ paths: description: Response content: application/json: - schema: *485 + schema: *481 examples: default: value: @@ -69156,9 +68754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69183,9 +68781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69236,9 +68834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69265,19 +68863,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: - - *448 - - *449 + - *444 + - *445 + - *482 + - *483 + - *484 + - *485 - *486 + - *17 + - *19 - *487 + - *466 - *488 - *489 - - *490 - - *17 - - *19 - - *491 - - *470 - - *492 - - *493 responses: '200': description: Response @@ -69293,9 +68891,9 @@ paths: type: integer workflow_runs: type: array - items: *471 + items: *467 examples: - default: *494 + default: *490 headers: Link: *45 x-github: @@ -69328,9 +68926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '200': description: Response @@ -69391,8 +68989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *448 - - *449 + - *444 + - *445 - *108 - *17 - *106 @@ -69560,8 +69158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -69598,8 +69196,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: - - *448 - - *449 + - *444 + - *445 - name: assignee in: path required: true @@ -69635,8 +69233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -69748,8 +69346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *106 - *107 @@ -69806,7 +69404,7 @@ paths: initiator: type: string examples: - default: *495 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69826,8 +69424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -69835,7 +69433,7 @@ paths: application/json: schema: type: array - items: &496 + items: &492 title: Autolink reference description: An autolink reference. type: object @@ -69894,8 +69492,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -69934,9 +69532,9 @@ paths: description: response content: application/json: - schema: *496 + schema: *492 examples: - default: &497 + default: &493 value: id: 1 key_prefix: TICKET- @@ -69967,9 +69565,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: - - *448 - - *449 - - &498 + - *444 + - *445 + - &494 name: autolink_id description: The unique identifier of the autolink. in: path @@ -69981,9 +69579,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *492 examples: - default: *497 + default: *493 '404': *6 x-github: githubCloudOnly: false @@ -70003,9 +69601,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: - - *448 - - *449 - - *498 + - *444 + - *445 + - *494 responses: '204': description: Response @@ -70029,8 +69627,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response if Dependabot is enabled @@ -70080,8 +69678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -70102,8 +69700,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -70123,8 +69721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *448 - - *449 + - *444 + - *445 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -70162,7 +69760,7 @@ paths: - url protected: type: boolean - protection: &500 + protection: &496 title: Branch Protection description: Branch Protection type: object @@ -70205,7 +69803,7 @@ paths: required: - contexts - checks - enforce_admins: &503 + enforce_admins: &499 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -70222,7 +69820,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &505 + required_pull_request_reviews: &501 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -70306,7 +69904,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &502 + restrictions: &498 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -70599,9 +70197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *448 - - *449 - - &501 + - *444 + - *445 + - &497 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). @@ -70615,14 +70213,14 @@ paths: description: Response content: application/json: - schema: &511 + schema: &507 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &560 + commit: &558 title: Commit description: Commit type: object @@ -70661,7 +70259,7 @@ paths: author: anyOf: - type: 'null' - - &499 + - &495 title: Git User description: Metaproperties for Git author/committer information. @@ -70683,7 +70281,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 message: type: string examples: @@ -70707,7 +70305,7 @@ paths: required: - sha - url - verification: &620 + verification: &618 title: Verification type: object properties: @@ -70787,7 +70385,7 @@ paths: type: integer files: type: array - items: &571 + items: &569 title: Diff Entry description: Diff Entry type: object @@ -70883,7 +70481,7 @@ paths: - self protected: type: boolean - protection: *500 + protection: *496 protection_url: type: string format: uri @@ -70992,7 +70590,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *454 + '301': *450 '404': *6 x-github: githubCloudOnly: false @@ -71014,15 +70612,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *500 + schema: *496 examples: default: value: @@ -71216,9 +70814,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -71478,7 +71076,7 @@ paths: url: type: string format: uri - required_status_checks: &508 + required_status_checks: &504 title: Status Check Policy description: Status Check Policy type: object @@ -71637,7 +71235,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *502 + restrictions: *498 required_conversation_resolution: type: object properties: @@ -71749,9 +71347,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -71776,17 +71374,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: &504 + default: &500 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -71808,17 +71406,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: *504 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71837,9 +71435,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -71864,17 +71462,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *505 + schema: *501 examples: - default: &506 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -71970,9 +71568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72070,9 +71668,9 @@ paths: description: Response content: application/json: - schema: *505 + schema: *501 examples: - default: *506 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72093,9 +71691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72122,17 +71720,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: &507 + default: &503 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -72155,17 +71753,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: *507 + default: *503 '404': *6 x-github: githubCloudOnly: false @@ -72185,9 +71783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72212,17 +71810,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *508 + schema: *504 examples: - default: &509 + default: &505 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -72248,9 +71846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72302,9 +71900,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *504 examples: - default: *509 + default: *505 '404': *6 '422': *15 x-github: @@ -72326,9 +71924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72352,9 +71950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72388,9 +71986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72457,9 +72055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72523,9 +72121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: content: application/json: @@ -72591,15 +72189,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *502 + schema: *498 examples: default: value: @@ -72690,9 +72288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72715,9 +72313,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72727,7 +72325,7 @@ paths: type: array items: *5 examples: - default: &510 + default: &506 value: - id: 1 slug: octoapp @@ -72784,9 +72382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72820,7 +72418,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72841,9 +72439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72877,7 +72475,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72898,9 +72496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72934,7 +72532,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72956,9 +72554,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72988,9 +72586,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -73049,9 +72647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -73110,9 +72708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: content: application/json: @@ -73171,9 +72769,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -73207,9 +72805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73267,9 +72865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73327,9 +72925,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73389,9 +72987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73413,7 +73011,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *507 examples: default: value: @@ -73527,8 +73125,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -73564,8 +73162,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73638,8 +73236,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -73679,8 +73277,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73750,8 +73348,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73822,8 +73420,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_response_id in: path required: true @@ -73856,8 +73454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -74136,7 +73734,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &508 title: CheckRun description: A check performed on the code of a given code change type: object @@ -74559,9 +74157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *448 - - *449 - - &513 + - *444 + - *445 + - &509 name: check_run_id description: The unique identifier of the check run. in: path @@ -74573,9 +74171,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *508 examples: - default: &514 + default: &510 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -74675,9 +74273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 requestBody: required: true content: @@ -74917,9 +74515,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *508 examples: - default: *514 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74939,9 +74537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 - *17 - *19 responses: @@ -75051,9 +74649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 responses: '201': description: Response @@ -75097,8 +74695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -75120,7 +74718,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &516 + schema: &512 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -75218,7 +74816,7 @@ paths: - string - 'null' format: date-time - head_commit: *515 + head_commit: *511 latest_check_runs_count: type: integer check_runs_url: @@ -75246,7 +74844,7 @@ paths: - check_runs_url - pull_requests examples: - default: &517 + default: &513 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -75537,9 +75135,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *516 + schema: *512 examples: - default: *517 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75558,8 +75156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -75868,9 +75466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *448 - - *449 - - &518 + - *444 + - *445 + - &514 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -75882,9 +75480,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *512 examples: - default: *517 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75907,17 +75505,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: - - *448 - - *449 - - *518 - - &566 + - *444 + - *445 + - *514 + - &564 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &567 + - &565 name: status description: Returns check runs with the specified `status`. in: query @@ -75956,9 +75554,9 @@ paths: type: integer check_runs: type: array - items: *512 + items: *508 examples: - default: &568 + default: &566 value: total_count: 1 check_runs: @@ -76060,9 +75658,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *448 - - *449 - - *518 + - *444 + - *445 + - *514 responses: '201': description: Response @@ -76095,21 +75693,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: - - *448 - - *449 + - *444 + - *445 - *305 - *306 - *19 - *17 - - &534 + - &530 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: *519 - - &535 + schema: *515 + - &531 name: pr description: The number of the pull request for the results you want to list. in: query @@ -76140,7 +75738,7 @@ paths: be returned. in: query required: false - schema: *520 + schema: *516 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -76164,7 +75762,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *521 + instances_url: *517 state: *111 fixed_at: *133 dismissed_by: @@ -76172,11 +75770,11 @@ paths: - type: 'null' - *4 dismissed_at: *132 - dismissed_reason: *522 - dismissed_comment: *523 - rule: *524 - tool: *525 - most_recent_instance: *526 + dismissed_reason: *518 + dismissed_comment: *519 + rule: *520 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -76299,7 +75897,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &527 + '403': &523 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -76326,9 +75924,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: - - *448 - - *449 - - &528 + - *444 + - *445 + - &524 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -76342,7 +75940,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &525 type: object properties: number: *123 @@ -76350,7 +75948,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *521 + instances_url: *517 state: *111 fixed_at: *133 dismissed_by: @@ -76358,8 +75956,8 @@ paths: - type: 'null' - *4 dismissed_at: *132 - dismissed_reason: *522 - dismissed_comment: *523 + dismissed_reason: *518 + dismissed_comment: *519 rule: type: object properties: @@ -76421,8 +76019,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *525 - most_recent_instance: *526 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -76518,7 +76116,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -76538,9 +76136,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: true content: @@ -76555,8 +76153,8 @@ paths: enum: - open - dismissed - dismissed_reason: *522 - dismissed_comment: *523 + dismissed_reason: *518 + dismissed_comment: *519 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -76584,7 +76182,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *525 examples: default: value: @@ -76660,7 +76258,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &533 + '403': &529 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -76687,15 +76285,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 responses: '200': description: Response content: application/json: - schema: &530 + schema: &526 type: object properties: status: @@ -76722,13 +76320,13 @@ paths: - description - started_at examples: - default: &531 + default: &527 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &532 + '400': &528 description: Bad Request content: application/json: @@ -76739,7 +76337,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': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -76764,29 +76362,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 responses: '200': description: OK content: application/json: - schema: *530 + schema: *526 examples: - default: *531 + default: *527 '202': description: Accepted content: application/json: - schema: *530 + schema: *526 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *532 + '400': *528 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -76818,9 +76416,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: false content: @@ -76866,8 +76464,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *532 - '403': *533 + '400': *528 + '403': *529 '404': *6 '422': description: Unprocessable Entity @@ -76891,13 +76489,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *19 - *17 - - *534 - - *535 + - *530 + - *531 responses: '200': description: Response @@ -76908,10 +76506,10 @@ paths: items: type: object properties: - ref: *519 - analysis_key: *536 - environment: *537 - category: *538 + ref: *515 + analysis_key: *532 + environment: *533 + category: *534 state: type: - string @@ -76928,7 +76526,7 @@ paths: properties: text: type: string - location: *539 + location: *535 html_url: type: string classifications: @@ -76936,7 +76534,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: *540 + items: *536 examples: default: value: @@ -76975,7 +76573,7 @@ paths: end_column: 50 classifications: - source - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77009,25 +76607,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: - - *448 - - *449 + - *444 + - *445 - *305 - *306 - *19 - *17 - - *535 + - *531 - 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: *519 + schema: *515 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &541 + schema: &537 type: string description: An identifier for the upload. examples: @@ -77049,23 +76647,23 @@ paths: application/json: schema: type: array - items: &542 + items: &538 type: object properties: - ref: *519 - commit_sha: &550 + ref: *515 + commit_sha: &546 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: *536 + analysis_key: *532 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *538 + category: *534 error: type: string examples: @@ -77090,8 +76688,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *541 - tool: *525 + sarif_id: *537 + tool: *521 deletable: type: boolean warning: @@ -77153,7 +76751,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77189,8 +76787,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: - - *448 - - *449 + - *444 + - *445 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77203,7 +76801,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *538 examples: response: summary: application/json response @@ -77257,7 +76855,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *527 + '403': *523 '404': *6 '422': description: Response if analysis could not be processed @@ -77344,8 +76942,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: - - *448 - - *449 + - *444 + - *445 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77401,7 +76999,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': *533 + '403': *529 '404': *6 '503': *189 x-github: @@ -77423,8 +77021,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -77432,7 +77030,7 @@ paths: application/json: schema: type: array - items: &543 + items: &539 title: CodeQL Database description: A CodeQL database. type: object @@ -77544,7 +77142,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': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77573,8 +77171,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: - - *448 - - *449 + - *444 + - *445 - name: language in: path description: The language of the CodeQL database. @@ -77586,7 +77184,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *539 examples: default: value: @@ -77618,9 +77216,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': &573 + '302': &571 description: Found - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77642,8 +77240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *448 - - *449 + - *444 + - *445 - name: language in: path description: The language of the CodeQL database. @@ -77653,7 +77251,7 @@ paths: responses: '204': description: Response - '403': *533 + '403': *529 '404': *6 '503': *189 x-github: @@ -77681,8 +77279,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -77691,7 +77289,7 @@ paths: type: object additionalProperties: false properties: - language: &544 + language: &540 type: string description: The language targeted by the CodeQL query enum: @@ -77771,7 +77369,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &548 + schema: &544 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -77781,7 +77379,7 @@ paths: description: The ID of the variant analysis. controller_repo: *117 actor: *4 - query_language: *544 + query_language: *540 query_pack_url: type: string description: The download url for the query pack. @@ -77829,7 +77427,7 @@ paths: items: type: object properties: - repository: &545 + repository: &541 title: Repository Identifier description: Repository Identifier type: object @@ -77871,7 +77469,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &549 + analysis_status: &545 type: string description: The new status of the CodeQL variant analysis repository task. @@ -77903,7 +77501,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &546 + access_mismatch_repos: &542 type: object properties: repository_count: @@ -77918,7 +77516,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: *545 + items: *541 required: - repository_count - repositories @@ -77941,8 +77539,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *546 - over_limit_repos: *546 + no_codeql_db_repos: *542 + over_limit_repos: *542 required: - access_mismatch_repos - not_found_repos @@ -77958,7 +77556,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &547 + value: &543 summary: Default response value: id: 1 @@ -78104,10 +77702,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *547 + value: *543 repository_lists: summary: Response for a successful variant analysis submission - value: *547 + value: *543 '404': *6 '422': description: Unable to process variant analysis submission @@ -78135,8 +77733,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: - - *448 - - *449 + - *444 + - *445 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -78148,9 +77746,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *544 examples: - default: *547 + default: *543 '404': *6 '503': *189 x-github: @@ -78173,7 +77771,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: - - *448 + - *444 - name: repo in: path description: The name of the controller repository. @@ -78208,7 +77806,7 @@ paths: type: object properties: repository: *117 - analysis_status: *549 + analysis_status: *545 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -78333,8 +77931,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -78427,7 +78025,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -78448,8 +78046,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -78543,7 +78141,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *533 + '403': *529 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -78614,8 +78212,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -78623,7 +78221,7 @@ paths: schema: type: object properties: - commit_sha: *550 + commit_sha: *546 ref: type: string description: |- @@ -78683,7 +78281,7 @@ paths: schema: type: object properties: - id: *541 + id: *537 url: type: string description: The REST API URL for checking the status of the upload. @@ -78697,7 +78295,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': *533 + '403': *529 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -78720,8 +78318,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: - - *448 - - *449 + - *444 + - *445 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -78769,7 +78367,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': *527 + '403': *523 '404': description: Not Found if the sarif id does not match any upload '503': *189 @@ -78794,8 +78392,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -78876,8 +78474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *448 - - *449 + - *444 + - *445 - 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 @@ -79005,8 +78603,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -79320,8 +78918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -79387,7 +78985,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -79395,7 +78993,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '400': *14 '401': *23 '403': *27 @@ -79424,8 +79022,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -79489,8 +79087,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: - - *448 - - *449 + - *444 + - *445 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -79527,7 +79125,7 @@ paths: type: integer machines: type: array - items: *552 + items: *548 examples: default: &788 value: @@ -79569,8 +79167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *448 - - *449 + - *444 + - *445 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -79657,8 +79255,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: - - *448 - - *449 + - *444 + - *445 - 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 @@ -79727,8 +79325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -79746,7 +79344,7 @@ paths: type: integer secrets: type: array - items: &556 + items: &552 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -79767,7 +79365,7 @@ paths: - created_at - updated_at examples: - default: *553 + default: *549 headers: Link: *45 x-github: @@ -79790,16 +79388,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *554 + schema: *550 examples: - default: *555 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -79819,17 +79417,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *556 + schema: *552 examples: - default: *557 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79849,8 +79447,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: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -79903,8 +79501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -79933,8 +79531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *448 - - *449 + - *444 + - *445 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -79972,7 +79570,7 @@ paths: application/json: schema: type: array - items: &558 + items: &554 title: Collaborator description: Collaborator type: object @@ -80165,8 +79763,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: - - *448 - - *449 + - *444 + - *445 - *136 responses: '204': @@ -80213,8 +79811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *448 - - *449 + - *444 + - *445 - *136 requestBody: required: false @@ -80241,7 +79839,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &633 + schema: &631 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -80469,8 +80067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *448 - - *449 + - *444 + - *445 - *136 responses: '204': @@ -80502,8 +80100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *448 - - *449 + - *444 + - *445 - *136 responses: '200': @@ -80524,7 +80122,7 @@ paths: user: anyOf: - type: 'null' - - *558 + - *554 required: - permission - role_name @@ -80578,8 +80176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -80589,7 +80187,7 @@ paths: application/json: schema: type: array - items: &559 + items: &555 title: Commit Comment description: Commit Comment type: object @@ -80647,7 +80245,7 @@ paths: - created_at - updated_at examples: - default: &562 + default: &560 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80706,17 +80304,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': description: Response content: application/json: - schema: *559 + schema: *555 examples: - default: &563 + default: &561 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80773,8 +80371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -80797,7 +80395,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *555 examples: default: value: @@ -80848,8 +80446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -80871,8 +80469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -80899,9 +80497,75 @@ paths: application/json: schema: type: array - items: *439 + items: &556 + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - *4 + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *441 + default: &635 + 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: *45 '404': *6 @@ -80922,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -80956,16 +80620,40 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: &557 + 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: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -80987,10 +80675,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - &636 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -81039,8 +80733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *448 - - *449 + - *444 + - *445 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -81096,7 +80790,7 @@ paths: application/json: schema: type: array - items: *560 + items: *558 examples: default: &682 value: @@ -81192,9 +80886,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *448 - - *449 - - &561 + - *444 + - *445 + - &559 name: commit_sha description: The SHA of the commit. in: path @@ -81266,9 +80960,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 - *17 - *19 responses: @@ -81278,9 +80972,9 @@ paths: application/json: schema: type: array - items: *559 + items: *555 examples: - default: *562 + default: *560 headers: Link: *45 x-github: @@ -81308,9 +81002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 requestBody: required: true content: @@ -81345,9 +81039,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *555 examples: - default: *563 + default: *561 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -81375,9 +81069,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: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 - *17 - *19 responses: @@ -81387,7 +81081,7 @@ paths: application/json: schema: type: array - items: *564 + items: *562 examples: default: &674 value: @@ -81926,11 +81620,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 - - &565 + - &563 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)" @@ -81945,7 +81639,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *558 examples: default: &660 value: @@ -82060,11 +81754,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: - - *448 - - *449 + - *444 + - *445 + - *563 + - *564 - *565 - - *566 - - *567 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -82098,9 +81792,9 @@ paths: type: integer check_runs: type: array - items: *512 + items: *508 examples: - default: *568 + default: *566 headers: Link: *45 x-github: @@ -82125,9 +81819,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: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -82135,7 +81829,7 @@ paths: schema: type: integer example: 1 - - *566 + - *564 - *17 - *19 responses: @@ -82153,7 +81847,7 @@ paths: type: integer check_suites: type: array - items: *516 + items: *512 examples: default: value: @@ -82353,9 +82047,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: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - *17 - *19 responses: @@ -82557,9 +82251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - *17 - *19 responses: @@ -82650,7 +82344,7 @@ paths: site_admin: false headers: Link: *45 - '301': *454 + '301': *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82678,8 +82372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -82712,11 +82406,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *569 + - *567 code_of_conduct_file: anyOf: - type: 'null' - - &570 + - &568 title: Community Health File type: object properties: @@ -82736,19 +82430,19 @@ paths: contributing: anyOf: - type: 'null' - - *570 + - *568 readme: anyOf: - type: 'null' - - *570 + - *568 issue_template: anyOf: - type: 'null' - - *570 + - *568 pull_request_template: anyOf: - type: 'null' - - *570 + - *568 required: - code_of_conduct - code_of_conduct_file @@ -82877,8 +82571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 - name: basehead @@ -82926,8 +82620,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *560 - merge_base_commit: *560 + base_commit: *558 + merge_base_commit: *558 status: type: string enum: @@ -82951,10 +82645,10 @@ paths: - 6 commits: type: array - items: *560 + items: *558 files: type: array - items: *571 + items: *569 required: - url - html_url @@ -83240,8 +82934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -83394,7 +83088,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &572 + response-if-content-is-a-file: &570 summary: Response if content is a file value: type: file @@ -83749,7 +83443,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *572 + response-if-content-is-a-file: *570 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -83818,7 +83512,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *573 + '302': *571 '304': *35 x-github: githubCloudOnly: false @@ -83841,8 +83535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -83937,7 +83631,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &572 title: File Commit description: File Commit type: object @@ -84093,7 +83787,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *572 examples: example-for-creating-a-file: value: @@ -84147,7 +83841,7 @@ paths: schema: oneOf: - *3 - - &615 + - &613 description: Repository rule violation was detected type: object properties: @@ -84200,8 +83894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -84262,7 +83956,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *572 examples: default: value: @@ -84317,8 +84011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *448 - - *449 + - *444 + - *445 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -84442,8 +84136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *321 - *322 - *323 @@ -84455,7 +84149,7 @@ paths: schema: type: string - *325 - - *575 + - *573 - *326 - *327 - *108 @@ -84476,7 +84170,7 @@ paths: application/json: schema: type: array - items: &579 + items: &577 type: object description: A Dependabot alert. properties: @@ -84526,7 +84220,7 @@ paths: - direct - transitive - - security_advisory: *576 + security_advisory: *574 security_vulnerability: *127 url: *128 html_url: *129 @@ -84557,8 +84251,8 @@ paths: dismissal. maxLength: 280 fixed_at: *133 - auto_dismissed_at: *577 - dismissal_request: *578 + auto_dismissed_at: *575 + dismissal_request: *576 required: - number - state @@ -84788,9 +84482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *448 - - *449 - - &580 + - *444 + - *445 + - &578 name: alert_number in: path description: |- @@ -84805,7 +84499,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *577 examples: default: value: @@ -84918,9 +84612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *448 - - *449 - - *580 + - *444 + - *445 + - *578 requestBody: required: true content: @@ -84965,7 +84659,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *577 examples: default: value: @@ -85094,8 +84788,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -85113,7 +84807,7 @@ paths: type: integer secrets: type: array - items: &583 + items: &581 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -85167,16 +84861,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *581 + schema: *579 examples: - default: *582 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85196,15 +84890,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *583 + schema: *581 examples: default: value: @@ -85230,8 +84924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -85284,8 +84978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -85308,8 +85002,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: - - *448 - - *449 + - *444 + - *445 - 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 @@ -85483,8 +85177,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -85744,8 +85438,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -85828,7 +85522,7 @@ paths: - version - url additionalProperties: false - metadata: &584 + metadata: &582 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85867,7 +85561,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *584 + metadata: *582 resolved: type: object description: A collection of resolved package dependencies. @@ -85881,7 +85575,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *584 + metadata: *582 relationship: type: string description: A notation of whether a dependency is requested @@ -86014,8 +85708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *448 - - *449 + - *444 + - *445 - name: sha description: The SHA recorded at creation time. in: query @@ -86056,9 +85750,9 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: - default: *586 + default: *584 headers: Link: *45 x-github: @@ -86124,8 +85818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -86207,7 +85901,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: simple-example: summary: Simple example @@ -86280,9 +85974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *448 - - *449 - - &587 + - *444 + - *445 + - &585 name: deployment_id description: deployment_id parameter in: path @@ -86294,7 +85988,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -86359,9 +86053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 responses: '204': description: Response @@ -86383,9 +86077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 - *17 - *19 responses: @@ -86395,7 +86089,7 @@ paths: application/json: schema: type: array - items: &588 + items: &586 title: Deployment Status description: The status of a deployment. type: object @@ -86559,9 +86253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 requestBody: required: true content: @@ -86636,9 +86330,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *586 examples: - default: &589 + default: &587 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -86694,9 +86388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 - name: status_id in: path required: true @@ -86707,9 +86401,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *586 examples: - default: *589 + default: *587 '404': *6 x-github: githubCloudOnly: false @@ -86736,12 +86430,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 + - *588 + - *589 - *590 - *591 - - *592 - - *593 - *17 - *19 responses: @@ -86751,9 +86445,9 @@ paths: application/json: schema: type: array - items: *594 + items: *592 examples: - default: *595 + default: *593 '404': *6 '403': *27 '500': *38 @@ -86777,8 +86471,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86790,7 +86484,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *594 + schema: *592 examples: default: value: @@ -86846,8 +86540,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86906,12 +86600,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 + - *588 + - *589 - *590 - *591 - - *592 - - *593 - *17 - *19 responses: @@ -86921,9 +86615,9 @@ paths: application/json: schema: type: array - items: *596 + items: *594 examples: - default: *597 + default: *595 '404': *6 '403': *27 '500': *38 @@ -86947,8 +86641,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86960,7 +86654,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *596 + schema: *594 examples: default: value: @@ -87011,8 +86705,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87050,7 +86744,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *596 + schema: *594 examples: default: value: @@ -87101,8 +86795,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87173,8 +86867,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87207,8 +86901,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -87222,9 +86916,9 @@ paths: application/json: schema: type: array - items: *598 + items: *596 examples: - default: *599 + default: *597 '404': *6 '403': *27 '500': *38 @@ -87249,8 +86943,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87262,7 +86956,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *598 + schema: *596 examples: default: value: @@ -87320,8 +87014,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87390,8 +87084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -87448,8 +87142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -87467,7 +87161,7 @@ paths: - 5 environments: type: array - items: &601 + items: &599 title: Environment description: Details of a deployment environment type: object @@ -87529,7 +87223,7 @@ paths: type: string examples: - wait_timer - wait_timer: &603 + wait_timer: &601 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -87571,7 +87265,7 @@ paths: items: type: object properties: - type: *600 + type: *598 reviewer: anyOf: - *4 @@ -87598,7 +87292,7 @@ paths: - id - node_id - type - deployment_branch_policy: &604 + deployment_branch_policy: &602 type: - object - 'null' @@ -87715,9 +87409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *448 - - *449 - - &602 + - *444 + - *445 + - &600 name: environment_name in: path required: true @@ -87730,9 +87424,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *599 examples: - default: &605 + default: &603 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -87816,9 +87510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: false content: @@ -87828,7 +87522,7 @@ paths: - object - 'null' properties: - wait_timer: *603 + wait_timer: *601 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -87847,14 +87541,14 @@ paths: items: type: object properties: - type: *600 + type: *598 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *604 + deployment_branch_policy: *602 additionalProperties: false examples: default: @@ -87874,9 +87568,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *599 examples: - default: *605 + default: *603 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -87900,9 +87594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 responses: '204': description: Default response @@ -87927,9 +87621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *17 - *19 responses: @@ -87948,7 +87642,7 @@ paths: - 2 branch_policies: type: array - items: &606 + items: &604 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -88009,9 +87703,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: true content: @@ -88059,9 +87753,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - example-wildcard: &607 + example-wildcard: &605 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -88103,10 +87797,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - &608 + - *444 + - *445 + - *600 + - &606 name: branch_policy_id in: path required: true @@ -88118,9 +87812,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - default: *607 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88139,10 +87833,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - *608 + - *444 + - *445 + - *600 + - *606 requestBody: required: true content: @@ -88171,9 +87865,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - default: *607 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88192,10 +87886,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - *608 + - *444 + - *445 + - *600 + - *606 responses: '204': description: Response @@ -88220,9 +87914,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 responses: '200': description: List of deployment protection rules @@ -88239,7 +87933,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &609 + items: &607 title: Deployment protection rule description: Deployment protection rule type: object @@ -88261,7 +87955,7 @@ paths: for the environment. examples: - true - app: &610 + app: &608 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -88364,9 +88058,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 requestBody: content: application/json: @@ -88387,9 +88081,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *609 + schema: *607 examples: - default: &611 + default: &609 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -88424,9 +88118,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 - *19 - *17 responses: @@ -88446,7 +88140,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *610 + items: *608 examples: default: value: @@ -88481,10 +88175,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: - - *448 - - *449 - - *602 - - &612 + - *444 + - *445 + - *600 + - &610 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -88496,9 +88190,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *607 examples: - default: *611 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88519,10 +88213,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: - - *602 - - *449 - - *448 - - *612 + - *600 + - *445 + - *444 + - *610 responses: '204': description: Response @@ -88548,9 +88242,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *17 - *19 responses: @@ -88568,9 +88262,9 @@ paths: type: integer secrets: type: array - items: *479 + items: *475 examples: - default: *480 + default: *476 headers: Link: *45 x-github: @@ -88595,17 +88289,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88627,18 +88321,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: - default: *613 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88660,9 +88354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 requestBody: required: true @@ -88720,9 +88414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 responses: '204': @@ -88748,10 +88442,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *448 - - *449 - - *602 - - *466 + - *444 + - *445 + - *600 + - *462 - *19 responses: '200': @@ -88768,9 +88462,9 @@ paths: type: integer variables: type: array - items: *483 + items: *479 examples: - default: *484 + default: *480 headers: Link: *45 x-github: @@ -88793,9 +88487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: true content: @@ -88847,18 +88541,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *479 examples: - default: *614 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88879,10 +88573,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 - - *602 + - *600 requestBody: required: true content: @@ -88924,10 +88618,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 - - *602 + - *600 responses: '204': description: Response @@ -88949,8 +88643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -89018,8 +88712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *448 - - *449 + - *444 + - *445 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -89178,8 +88872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -89212,9 +88906,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 '400': *14 '422': *15 '403': *27 @@ -89235,8 +88929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89296,7 +88990,7 @@ paths: schema: oneOf: - *247 - - *615 + - *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89321,8 +89015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *448 - - *449 + - *444 + - *445 - name: file_sha in: path required: true @@ -89422,8 +89116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89532,7 +89226,7 @@ paths: description: Response content: application/json: - schema: &616 + schema: &614 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -89759,15 +89453,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 responses: '200': description: Response content: application/json: - schema: *616 + schema: *614 examples: default: value: @@ -89823,9 +89517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *448 - - *449 - - &617 + - *444 + - *445 + - &615 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. @@ -89842,7 +89536,7 @@ paths: application/json: schema: type: array - items: &618 + items: &616 title: Git Reference description: Git references within a repository type: object @@ -89918,17 +89612,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: &619 + default: &617 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -89957,8 +89651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89987,9 +89681,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: *619 + default: *617 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -90015,9 +89709,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 requestBody: required: true content: @@ -90046,9 +89740,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: *619 + default: *617 '422': *15 '409': *116 x-github: @@ -90066,9 +89760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 responses: '204': description: Response @@ -90123,8 +89817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -90191,7 +89885,7 @@ paths: description: Response content: application/json: - schema: &621 + schema: &619 title: Git Tag description: Metadata for a Git tag type: object @@ -90247,7 +89941,7 @@ paths: - sha - type - url - verification: *620 + verification: *618 required: - sha - url @@ -90257,7 +89951,7 @@ paths: - tag - message examples: - default: &622 + default: &620 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -90330,8 +90024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *448 - - *449 + - *444 + - *445 - name: tag_sha in: path required: true @@ -90342,9 +90036,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *619 examples: - default: *622 + default: *620 '404': *6 '409': *116 x-github: @@ -90368,8 +90062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -90443,7 +90137,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &621 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -90545,8 +90239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *448 - - *449 + - *444 + - *445 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -90569,7 +90263,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *621 examples: default-response: summary: Default response @@ -90628,8 +90322,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -90639,7 +90333,7 @@ paths: application/json: schema: type: array - items: &624 + items: &622 title: Webhook description: Webhooks for repositories. type: object @@ -90779,8 +90473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -90833,9 +90527,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: &625 + default: &623 value: type: Repository id: 12345678 @@ -90883,17 +90577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '200': description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *625 + default: *623 '404': *6 x-github: githubCloudOnly: false @@ -90913,8 +90607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 requestBody: required: true @@ -90960,9 +90654,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *625 + default: *623 '422': *15 '404': *6 x-github: @@ -90983,8 +90677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91009,8 +90703,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: - - *448 - - *449 + - *444 + - *445 - *335 responses: '200': @@ -91038,8 +90732,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: - - *448 - - *449 + - *444 + - *445 - *335 requestBody: required: false @@ -91084,8 +90778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 - *17 - *336 @@ -91117,8 +90811,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: - - *448 - - *449 + - *444 + - *445 - *335 - *16 responses: @@ -91147,8 +90841,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: - - *448 - - *449 + - *444 + - *445 - *335 - *16 responses: @@ -91172,8 +90866,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91199,8 +90893,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91224,8 +90918,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response if immutable releases are enabled @@ -91273,8 +90967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '409': *116 @@ -91294,8 +90988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '409': *116 @@ -91352,14 +91046,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &626 + schema: &624 title: Import description: A repository import from an external source. type: object @@ -91466,7 +91160,7 @@ paths: - html_url - authors_url examples: - default: &629 + default: &627 value: vcs: subversion use_lfs: true @@ -91482,7 +91176,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': &627 + '503': &625 description: Unavailable due to service under maintenance. content: application/json: @@ -91511,8 +91205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -91560,7 +91254,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: default: value: @@ -91585,7 +91279,7 @@ paths: type: string '422': *15 '404': *6 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91613,8 +91307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -91666,7 +91360,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: example-1: summary: Example 1 @@ -91714,7 +91408,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': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91737,12 +91431,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91768,8 +91462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *448 - - *449 + - *444 + - *445 - &809 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -91784,7 +91478,7 @@ paths: application/json: schema: type: array - items: &628 + items: &626 title: Porter Author description: Porter Author type: object @@ -91838,7 +91532,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': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91863,8 +91557,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *448 - - *449 + - *444 + - *445 - name: author_id in: path required: true @@ -91894,7 +91588,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *626 examples: default: value: @@ -91907,7 +91601,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91931,8 +91625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -91973,7 +91667,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92001,8 +91695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -92029,11 +91723,11 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: - default: *629 + default: *627 '422': *15 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92056,8 +91750,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -92065,8 +91759,8 @@ paths: application/json: schema: *20 examples: - default: *630 - '301': *454 + default: *628 + '301': *450 '404': *6 x-github: githubCloudOnly: false @@ -92086,8 +91780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -92100,7 +91794,7 @@ paths: properties: {} additionalProperties: false examples: - default: &632 + default: &630 value: limit: collaborators_only origin: repository @@ -92125,13 +91819,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *631 + schema: *629 examples: default: summary: Example request body @@ -92145,7 +91839,7 @@ paths: application/json: schema: *353 examples: - default: *632 + default: *630 '409': description: Response x-github: @@ -92167,8 +91861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -92191,8 +91885,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -92202,7 +91896,7 @@ paths: application/json: schema: type: array - items: *633 + items: *631 examples: default: &802 value: @@ -92335,8 +92029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *448 - - *449 + - *444 + - *445 - *357 requestBody: required: false @@ -92366,7 +92060,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *631 examples: default: value: @@ -92497,8 +92191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *448 - - *449 + - *444 + - *445 - *357 responses: '204': @@ -92530,8 +92224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *448 - - *449 + - *444 + - *445 - 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 @@ -92752,7 +92446,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *454 + '301': *450 '422': *15 '404': *6 x-github: @@ -92781,8 +92475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -93030,7 +92724,7 @@ paths: '422': *15 '503': *189 '404': *6 - '410': *634 + '410': *632 x-github: triggersNotification: true githubCloudOnly: false @@ -93058,8 +92752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *235 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -93080,7 +92774,7 @@ paths: application/json: schema: type: array - items: *635 + items: *633 examples: default: &640 value: @@ -93140,17 +92834,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: &636 + default: &634 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -93204,8 +92898,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -93228,9 +92922,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: *636 + default: *634 '422': *15 x-github: githubCloudOnly: false @@ -93248,8 +92942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -93270,8 +92964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -93298,9 +92992,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -93321,8 +93015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -93355,16 +93049,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -93386,10 +93080,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - *636 responses: '204': description: Response @@ -93409,8 +93103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -93759,8 +93453,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *448 - - *449 + - *444 + - *445 - name: event_id in: path required: true @@ -93963,7 +93657,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *634 + '410': *632 '403': *27 x-github: githubCloudOnly: false @@ -93997,8 +93691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - &639 name: issue_number description: The number that identifies the issue. @@ -94014,9 +93708,9 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '304': *35 x-github: githubCloudOnly: false @@ -94041,8 +93735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -94168,9 +93862,9 @@ paths: '422': *15 '503': *189 '403': *27 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94188,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -94234,8 +93928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: content: @@ -94285,8 +93979,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: - - *448 - - *449 + - *444 + - *445 - *639 - name: assignee in: path @@ -94327,8 +94021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *218 - *17 @@ -94340,13 +94034,13 @@ paths: application/json: schema: type: array - items: *635 + items: *633 examples: default: *640 headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94375,8 +94069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -94399,16 +94093,16 @@ paths: description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: *636 + default: *634 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -94436,8 +94130,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: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -94453,9 +94147,9 @@ paths: default: *641 headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94483,8 +94177,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: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -94515,9 +94209,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *454 + '301': *450 '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -94548,8 +94242,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: - - *448 - - *449 + - *444 + - *445 - *639 - name: issue_id in: path @@ -94565,12 +94259,12 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *634 + '410': *632 x-github: triggersNotification: true githubCloudOnly: false @@ -94596,8 +94290,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: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -94613,9 +94307,9 @@ paths: default: *641 headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94632,8 +94326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -95427,7 +95121,7 @@ paths: color: red headers: Link: *45 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95444,8 +95138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -95476,9 +95170,9 @@ paths: default: false headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95495,8 +95189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95559,9 +95253,9 @@ paths: items: *211 examples: default: *642 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '422': *15 x-github: githubCloudOnly: false @@ -95578,8 +95272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95643,9 +95337,9 @@ paths: items: *211 examples: default: *642 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '422': *15 x-github: githubCloudOnly: false @@ -95662,15 +95356,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '204': description: Response - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95689,8 +95383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - name: name in: path @@ -95715,9 +95409,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95737,8 +95431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95768,7 +95462,7 @@ paths: '204': description: Response '403': *27 - '410': *634 + '410': *632 '404': *6 '422': *15 x-github: @@ -95786,8 +95480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '204': @@ -95818,8 +95512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '200': @@ -95829,9 +95523,9 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95848,8 +95542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -95876,13 +95570,13 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95900,8 +95594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -95934,16 +95628,16 @@ paths: description: Response content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Response content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -95965,10 +95659,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *639 - - *442 + - *636 responses: '204': description: Response @@ -95997,8 +95691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96056,8 +95750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -96074,7 +95768,7 @@ paths: headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96102,8 +95796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96140,7 +95834,7 @@ paths: schema: type: string '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -96160,8 +95854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96217,8 +95911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -96813,7 +96507,7 @@ paths: type: string comments: type: array - items: *559 + items: *555 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -97088,7 +96782,7 @@ paths: headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97105,8 +96799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -97184,8 +96878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97257,8 +96951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 - &658 name: key_id description: The unique identifier of the key. @@ -97291,8 +96985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 - *658 responses: '204': @@ -97313,8 +97007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -97347,8 +97041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97418,8 +97112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97449,8 +97143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97515,8 +97209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97542,8 +97236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -97579,8 +97273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '202': *37 '403': @@ -97608,8 +97302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -97635,9 +97329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *448 - - *449 - - *534 + - *444 + - *445 + - *530 responses: '200': description: Response @@ -97784,8 +97478,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97850,8 +97544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97885,7 +97579,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *560 + schema: *558 examples: default: *660 '204': @@ -97912,8 +97606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *448 - - *449 + - *444 + - *445 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -98010,8 +97704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98112,8 +97806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - &662 name: milestone_number description: The number that identifies the milestone. @@ -98145,8 +97839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - *662 requestBody: required: false @@ -98203,8 +97897,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - *662 responses: '204': @@ -98226,8 +97920,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: - - *448 - - *449 + - *444 + - *445 - *662 - *17 - *19 @@ -98259,8 +97953,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: - - *448 - - *449 + - *444 + - *445 - *663 - *664 - *218 @@ -98300,8 +97994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -98359,8 +98053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -98551,8 +98245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98632,8 +98326,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98741,8 +98435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -98768,8 +98462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -98871,8 +98565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -98919,8 +98613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -98976,8 +98670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *448 - - *449 + - *444 + - *445 - name: build_id in: path required: true @@ -99010,8 +98704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -99119,8 +98813,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: - - *448 - - *449 + - *444 + - *445 - &671 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -99179,8 +98873,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *448 - - *449 + - *444 + - *445 - *671 responses: '204': *148 @@ -99208,8 +98902,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -99504,8 +99198,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Private vulnerability reporting status @@ -99542,8 +99236,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: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '422': *14 @@ -99564,8 +99258,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: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '422': *14 @@ -99587,8 +99281,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -99620,8 +99314,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -99675,8 +99369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -99736,7 +99430,7 @@ paths: application/json: schema: type: array - items: *564 + items: *562 examples: default: *674 headers: @@ -99770,8 +99464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -100707,8 +100401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - name: sort in: query required: false @@ -100816,8 +100510,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: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': @@ -100901,8 +100595,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: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -100943,8 +100637,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: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -100966,8 +100660,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: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -100994,9 +100688,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -101017,8 +100711,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: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -101051,16 +100745,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -101082,10 +100776,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - *636 responses: '204': description: Response @@ -101128,8 +100822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - &680 name: pull_number description: The number that identifies the pull request. @@ -101180,8 +100874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -101248,8 +100942,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -101313,7 +101007,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -101321,7 +101015,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -101351,8 +101045,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: - - *448 - - *449 + - *444 + - *445 - *680 - *235 - name: direction @@ -101409,8 +101103,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -101605,8 +101299,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: - - *448 - - *449 + - *444 + - *445 - *680 - *227 requestBody: @@ -101716,8 +101410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -101728,7 +101422,7 @@ paths: application/json: schema: type: array - items: *560 + items: *558 examples: default: *682 headers: @@ -101760,8 +101454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -101772,7 +101466,7 @@ paths: application/json: schema: type: array - items: *571 + items: *569 examples: default: value: @@ -101810,8 +101504,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: - - *448 - - *449 + - *444 + - *445 - *680 responses: '204': @@ -101835,8 +101529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -101949,8 +101643,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: - - *448 - - *449 + - *444 + - *445 - *680 responses: '200': @@ -102026,8 +101720,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -102065,7 +101759,7 @@ paths: description: Response content: application/json: - schema: *564 + schema: *562 examples: default: value: @@ -102601,8 +102295,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -102637,7 +102331,7 @@ paths: description: Response content: application/json: - schema: *564 + schema: *562 examples: default: value: @@ -103142,8 +102836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -103310,8 +103004,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -103467,8 +103161,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: - - *448 - - *449 + - *444 + - *445 - *680 - &684 name: review_id @@ -103543,8 +103237,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -103631,8 +103325,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 responses: @@ -103669,8 +103363,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 - *17 @@ -103930,8 +103624,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -104025,8 +103719,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -104087,8 +103781,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -104153,8 +103847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *448 - - *449 + - *444 + - *445 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -104211,8 +103905,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: - - *448 - - *449 + - *444 + - *445 - name: dir description: The alternate path to look for a README file in: path @@ -104256,8 +103950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -104361,8 +104055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -104545,8 +104239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - &691 name: asset_id description: The unique identifier of the asset. @@ -104596,7 +104290,7 @@ paths: type: User site_admin: false '404': *6 - '302': *573 + '302': *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104612,8 +104306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - *691 requestBody: required: false @@ -104661,8 +104355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - *691 responses: '204': @@ -104687,8 +104381,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -104774,8 +104468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -104800,8 +104494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *448 - - *449 + - *444 + - *445 - name: tag description: tag parameter in: path @@ -104838,8 +104532,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *448 - - *449 + - *444 + - *445 - &694 name: release_id description: The unique identifier of the release. @@ -104874,8 +104568,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 requestBody: required: false @@ -104963,8 +104657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 responses: '204': @@ -104985,8 +104679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *448 - - *449 + - *444 + - *445 - *694 - *17 - *19 @@ -105079,8 +104773,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: - - *448 - - *449 + - *444 + - *445 - *694 - name: name in: query @@ -105162,8 +104856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -105188,9 +104882,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -105211,8 +104905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 requestBody: required: true @@ -105243,16 +104937,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -105274,10 +104968,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *694 - - *442 + - *636 responses: '204': description: Response @@ -105301,9 +104995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 - *17 - *19 responses: @@ -105440,8 +105134,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - name: includes_parents @@ -105507,8 +105201,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 requestBody: description: Request body required: true @@ -105617,8 +105311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *448 - - *449 + - *444 + - *445 - *699 - *103 - *700 @@ -105653,8 +105347,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *448 - - *449 + - *444 + - *445 - *704 responses: '200': @@ -105691,8 +105385,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105732,8 +105426,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105815,8 +105509,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105839,8 +105533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - name: ruleset_id @@ -105877,8 +105571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105951,8 +105645,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: - - *448 - - *449 + - *444 + - *445 - *410 - *411 - *412 @@ -106230,9 +105924,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *418 responses: '200': @@ -106293,9 +105987,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: true content: @@ -106435,9 +106129,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *19 - *17 responses: @@ -106573,8 +106267,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -106653,8 +106347,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: - - *448 - - *449 + - *444 + - *445 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -106775,8 +106469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *448 - - *449 + - *444 + - *445 - *108 - name: sort description: The property to sort the results by. @@ -106845,8 +106539,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -107251,8 +106945,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -107512,8 +107206,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '200': @@ -107546,8 +107240,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: - - *448 - - *449 + - *444 + - *445 - *732 requestBody: required: true @@ -107760,8 +107454,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '202': *37 @@ -107789,17 +107483,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '202': description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 '400': *14 '422': *15 '403': *27 @@ -107825,8 +107519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -107922,8 +107616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -107965,8 +107659,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108044,8 +107738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108139,8 +107833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -108294,8 +107988,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -108338,8 +108032,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *448 - - *449 + - *444 + - *445 - name: sha in: path required: true @@ -108449,8 +108143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108482,8 +108176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: if you subscribe to the repository @@ -108562,8 +108256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -108616,8 +108310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -108637,8 +108331,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108720,8 +108414,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108786,8 +108480,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -108841,8 +108535,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: - - *448 - - *449 + - *444 + - *445 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -108879,8 +108573,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *448 - - *449 + - *444 + - *445 - name: ref in: path required: true @@ -108916,8 +108610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108949,8 +108643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 responses: @@ -108993,8 +108687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -109048,8 +108742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *448 - - *449 + - *444 + - *445 - &740 name: per description: The time frame to display results for. @@ -109169,8 +108863,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -109265,8 +108959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -109330,8 +109024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *448 - - *449 + - *444 + - *445 - *740 responses: '200': @@ -109431,8 +109125,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -109706,8 +109400,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -109730,8 +109424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -109753,8 +109447,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -109780,8 +109474,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *448 - - *449 + - *444 + - *445 - name: ref in: path required: true @@ -109873,9 +109567,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -112427,7 +112121,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 comment_count: type: integer message: @@ -112446,7 +112140,7 @@ paths: url: type: string format: uri - verification: *620 + verification: *618 required: - author - committer @@ -112461,7 +112155,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 parents: type: array items: @@ -114675,246 +114369,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: - - *773 - - *435 - - *438 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *773 - - *435 - - *438 - 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: *439 - examples: - default: *440 - 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: - - *773 - - *435 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *773 - - *435 - 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: *439 - examples: - default: *440 - 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) @@ -115140,7 +114594,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-user-is-a-team-maintainer: *778 '404': *6 @@ -115201,7 +114655,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-users-membership-with-team-is-now-pending: *779 '403': @@ -115308,8 +114762,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Alternative response with extra repository information @@ -115467,8 +114921,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -115519,8 +114973,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -115555,9 +115009,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: - default: *451 + default: *447 '403': *27 '404': *6 x-github: @@ -115645,7 +115099,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: default: value: @@ -116477,7 +115931,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -116485,7 +115939,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -116571,7 +116025,7 @@ paths: - visibility - selected_repositories_url examples: - default: *553 + default: *549 headers: Link: *45 x-github: @@ -116947,7 +116401,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '304': *35 '500': *38 '401': *23 @@ -117005,7 +116459,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -117199,7 +116653,7 @@ paths: type: integer machines: type: array - items: *552 + items: *548 examples: default: *788 '304': *35 @@ -117286,11 +116740,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *453 + repository: *449 machine: anyOf: - type: 'null' - - *552 + - *548 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -118095,7 +117549,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '304': *35 '500': *38 '400': *14 @@ -118135,7 +117589,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '500': *38 '401': *23 '403': *27 @@ -119306,7 +118760,7 @@ paths: required: true content: application/json: - schema: *631 + schema: *629 examples: default: value: @@ -121771,9 +121225,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -121811,7 +121265,7 @@ paths: application/json: schema: type: array - items: *633 + items: *631 examples: default: *802 headers: @@ -122430,8 +121884,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response if this repository is starred by you @@ -122459,8 +121913,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -122484,8 +121938,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -123166,7 +122620,7 @@ paths: initiator: type: string examples: - default: *495 + default: *491 '201': description: Response content: @@ -123697,7 +123151,7 @@ paths: application/json: schema: *20 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -131573,7 +131027,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131905,7 +131359,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132249,7 +131703,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132608,7 +132062,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132891,7 +132345,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133189,7 +132643,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133510,7 +132964,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -134622,7 +134076,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134710,7 +134164,7 @@ webhooks: type: string enum: - auto_reopened - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134798,7 +134252,7 @@ webhooks: type: string enum: - created - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134884,7 +134338,7 @@ webhooks: type: string enum: - dismissed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134970,7 +134424,7 @@ webhooks: type: string enum: - fixed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -135057,7 +134511,7 @@ webhooks: type: string enum: - reintroduced - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -135143,7 +134597,7 @@ webhooks: type: string enum: - reopened - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -136661,7 +136115,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *585 + deployment: *583 pull_requests: type: array items: *678 @@ -168055,7 +167509,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *515 + head_commit: *511 required: - head_sha - head_ref @@ -242539,7 +241993,7 @@ webhooks: enterprise: *832 installation: *833 organization: *834 - repository: *453 + repository: *449 sender: *4 required: - changes @@ -247869,7 +247323,7 @@ webhooks: type: string required: - conclusion - deployment: *585 + deployment: *583 required: - action - repository @@ -248233,7 +247687,7 @@ webhooks: required: - status - steps - deployment: *585 + deployment: *583 required: - action - repository @@ -248461,7 +247915,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *585 + deployment: *583 required: - action - repository @@ -248690,7 +248144,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *585 + deployment: *583 required: - action - repository diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 67e39e154..e673fc5d8 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -287743,17 +287743,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": [ { @@ -287773,42 +287773,406 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + } + }, + "patch": { + "summary": "Update the connection between an external group and a team", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/link-external-idp-group-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group_id": { + "type": "integer", + "description": "External Group Id", + "examples": [ + 1 + ] + } + }, + "required": [ + "group_id" + ] + }, + "examples": { + "default": { + "value": { + "group_id": 123 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" + } + }, + "delete": { + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/unlink-external-idp-group-from-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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" + } + } + ], + "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": "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, + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "type": "string" } }, { @@ -287838,228 +288202,244 @@ "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", - "examples": [ - 1 + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" + "email": { + "type": [ + "string", + "null" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "team_count": { + "type": "integer" + }, + "node_id": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" ] }, - "created_at": { + "invitation_teams_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -288068,29 +288448,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" } ] } @@ -288110,20 +288497,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/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.", + } + }, + "/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/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members" }, "parameters": [ { @@ -288145,296 +288534,219 @@ } }, { - "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/enterprise-cloud@latest//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/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" - } - } - } + }, + { + "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 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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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=", @@ -288453,297 +288765,146 @@ "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/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" } }, - "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", - "examples": [ - 1 - ] - }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "format": "uri" }, - "content": { - "description": "The reaction to use", - "type": "string", + "role": { + "description": "The role of the user in the team.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "member", + "maintainer" ], + "default": "member", + "type": "string", "examples": [ - "heart" + "member" ] }, - "created_at": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "enum": [ + "active", + "pending" ] } }, "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/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.", + }, + "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": [ - "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/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -288765,57 +288926,179 @@ } }, { - "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", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "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/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 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/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -288836,34 +289119,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).\"", @@ -288891,228 +289146,869 @@ "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", + "format": "int64", "examples": [ - 1 + 1296269 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ - { - "type": "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "content": { - "description": "The reaction to use", + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -289120,9 +290016,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=", @@ -289142,8 +290040,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_validity_checks": { + "status": "disabled" + } + } } ] } @@ -289163,20 +290151,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/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}/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-cloud@latest//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/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -289198,336 +290188,157 @@ } }, { - "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/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": "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": { + "description": "Unique identifier of the repository", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "user": { - "anyOf": [ + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "key": { "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "mit" ] }, - "node_id": { + "name": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MIT License" ] }, - "avatar_url": { - "type": "string", + "url": { + "type": [ + "string", + "null" + ], "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/licenses/mit" ] }, - "gravatar_id": { + "spdx_id": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MIT" ] }, - "url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "MDc6TGljZW5zZW1pdA==" ] }, "html_url": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "format": "uri" } }, "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" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] + "forks": { + "type": "integer" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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 + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "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", - "examples": [ - 1 + "required": [ + "admin", + "pull", + "push" ] }, - "node_id": { + "role_name": { "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" + "admin" ] }, - "user": { + "owner": { "anyOf": [ { "type": "null" @@ -289702,45 +290513,606 @@ } ] }, - "content": { - "description": "The reaction to use", + "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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "heart" + "This your first repo!" ] }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + 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", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + 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", - "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", + "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": { - "default": { + "alternative-response-with-repository-permissions": { "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=", @@ -289760,34 +291132,135 @@ "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, + "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": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" } - } - }, - "/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.", + }, + "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-cloud@latest//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-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/add-or-update-repo-permissions-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/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -289809,48 +291282,133 @@ } }, { - "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" } } ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { + "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": "reactions", - "subcategory": "reactions" + "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/enterprise-cloud@latest//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}/external-groups": { + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { "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.", + "summary": "List IdP groups for a team", + "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\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> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", + "operationId": "teams/list-idp-groups-in-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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team" }, "parameters": [ { @@ -289878,38 +291436,55 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", + "title": "GroupMapping", + "description": "External Groups to be mapped to a team for membership", "type": "object", "properties": { "groups": { - "description": "An array of external groups available to be mapped to a team", + "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ "group_id", "group_name", - "updated_at" + "group_description" ], "properties": { "group_id": { - "description": "The internal ID of the group", - "type": "integer", + "description": "The ID of the group", + "type": "string", "examples": [ - 1 + "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, "group_name": { - "description": "The display name of the group", + "description": "The name of the group", "type": "string", "examples": [ - "group-azuread-test" + "saml-azuread-test" ] }, - "updated_at": { - "description": "The time of the last update for this group", + "group_description": { + "description": "a description of the group", + "type": "string", + "examples": [ + "A group of Developers working on AzureAD SAML SSO" + ] + }, + "status": { + "description": "synchronization status for this group mapping", "type": "string", + "examples": [ + "unsynced" + ] + }, + "synced_at": { + "description": "the time of the last sync for this group-mapping", + "type": [ + "string", + "null" + ], "examples": [ "2019-06-03 22:27:15:000 -700" ] @@ -289918,14 +291493,14 @@ }, "examples": [ { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" + "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "group_name": "saml-azuread-test", + "group_description": "A group of Developers working on AzureAD SAML SSO" }, { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" + "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + "group_name": "saml-azuread-test2", + "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } @@ -289938,12 +291513,12 @@ { "group_id": "123", "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" + "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" + "group_description": "The people who make your octoworld come to life." } ] } @@ -289955,21 +291530,21 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "category": "teams", - "subcategory": "external-groups" + "subcategory": "team-sync" } }, "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.", + "summary": "Create or update IdP group connections", + "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for 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> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], - "operationId": "teams/link-external-idp-group-to-team-for-org", + "operationId": "teams/create-or-update-idp-group-connections-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/team-sync#create-or-update-idp-group-connections" }, "parameters": [ { @@ -289998,22 +291573,45 @@ "schema": { "type": "object", "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "examples": [ - 1 - ] + "groups": { + "type": "array", + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", + "items": { + "type": "object", + "properties": { + "group_id": { + "type": "string", + "description": "ID of the IdP group." + }, + "group_name": { + "type": "string", + "description": "Name of the IdP group." + }, + "group_description": { + "type": "string", + "description": "Description of the IdP group." + } + }, + "required": [ + "group_id", + "group_name", + "group_description" + ] + } } }, - "required": [ - "group_id" - ] + "additionalProperties": false }, "examples": { "default": { "value": { - "group_id": 123 + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "string" + } + ] } } } @@ -290026,128 +291624,71 @@ "content": { "application/json": { "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", + "title": "GroupMapping", + "description": "External Groups to be mapped to a team for membership", "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", + "groups": { + "description": "Array of groups to be mapped to this team", "type": "array", "items": { "type": "object", "required": [ - "team_id", - "team_name" + "group_id", + "group_name", + "group_description" ], "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer", + "group_id": { + "description": "The ID of the group", + "type": "string", "examples": [ - 1 + "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" ] }, - "team_name": { - "description": "The name of the team", + "group_name": { + "description": "The name of the group", "type": "string", "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 + "saml-azuread-test" ] }, - "member_login": { - "description": "The handle/login for the user", + "group_description": { + "description": "a description of the group", "type": "string", "examples": [ - "mona-lisa_eocsaxrs" + "A group of Developers working on AzureAD SAML SSO" ] }, - "member_name": { - "description": "The user display name/profile name", + "status": { + "description": "synchronization status for this group mapping", "type": "string", "examples": [ - "Mona Lisa" + "unsynced" ] }, - "member_email": { - "description": "An email attached to a user", - "type": "string", + "synced_at": { + "description": "the time of the last sync for this group-mapping", + "type": [ + "string", + "null" + ], "examples": [ - "mona_lisa@github.com" + "2019-06-03 22:27:15:000 -700" ] } } }, "examples": [ { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" + "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "group_name": "saml-azuread-test", + "group_description": "A group of Developers working on AzureAD SAML SSO" }, { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" + "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + "group_name": "saml-azuread-test2", + "group_description": "Another group of Developers working on AzureAD SAML SSO" } ] } @@ -290156,31 +291697,16 @@ "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": [ + "groups": [ { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "The people who configure your octoworld." }, { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" + "group_id": "456", + "group_name": "Octocat docs members", + "group_description": "The people who make your octoworld come to life." } ] } @@ -290194,64 +291720,21 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" + "subcategory": "team-sync" } } }, - "/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 Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "List 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/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -290293,288 +291776,298 @@ ], "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", - "null" - ] + "type": "integer" }, - "email": { - "type": [ - "string", - "null" - ] + "node_id": { + "type": "string" }, - "role": { + "name": { "type": "string" }, - "created_at": { + "slug": { "type": "string" }, - "failed_at": { + "description": { "type": [ "string", "null" ] }, - "failed_reason": { - "type": [ - "string", - "null" - ] + "privacy": { + "type": "string" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "type": "boolean" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "team_count": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "node_id": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://github.com/orgs/rails/teams/core" ] }, - "invitation_teams_url": { + "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", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + 37 ] }, - "invitation_source": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "\"member\"" + 42 + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + } ] } }, "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" } ] } @@ -290595,21 +292088,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/enterprise-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -290622,400 +292115,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" + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] } }, { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, + "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": [ - "member", - "maintainer", - "all" - ], - "default": "all" + "enable_all", + "disable_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 + } + ], + "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" }, - { - "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 - } + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + }, + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "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" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "core", + "search" + ] }, - "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" - ] - } + "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": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": { + "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": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "type": "string" + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } - } - }, - "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" - } + "304": { + "description": "Not modified" }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "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", - "type": "string", - "examples": [ - "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-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" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "404": { - "description": "if user has no team membership" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "rate-limit", + "subcategory": "rate-limit" } - }, - "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}`.", + } + }, + "/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/enterprise-cloud@latest//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/add-or-update-membership-for-user-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-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.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -291023,8 +292705,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -291032,4021 +292714,242 @@ } } ], - "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", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", - "format": "uri" + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "default": "member", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "member" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "state": { - "description": "The state of the user's membership in the team.", + "archive_url": { "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if team synchronization is set up" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Alternative response with repository permissions", - "content": { - "application/json": { - "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - 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/enterprise-cloud@latest//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-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//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}/team-sync/group-mappings": { - "get": { - "summary": "List IdP groups for a team", - "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\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> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-idp-groups-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-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": "GroupMapping", - "description": "External Groups to be mapped to a team for membership", - "type": "object", - "properties": { - "groups": { - "description": "Array of groups to be mapped to this team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "group_description" - ], - "properties": { - "group_id": { - "description": "The ID of the group", - "type": "string", - "examples": [ - "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" - ] - }, - "group_name": { - "description": "The name of the group", - "type": "string", - "examples": [ - "saml-azuread-test" - ] - }, - "group_description": { - "description": "a description of the group", - "type": "string", - "examples": [ - "A group of Developers working on AzureAD SAML SSO" - ] - }, - "status": { - "description": "synchronization status for this group mapping", - "type": "string", - "examples": [ - "unsynced" - ] - }, - "synced_at": { - "description": "the time of the last sync for this group-mapping", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", - "group_name": "saml-azuread-test", - "group_description": "A group of Developers working on AzureAD SAML SSO" - }, - { - "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", - "group_name": "saml-azuread-test2", - "group_description": "Another group of Developers working on AzureAD SAML SSO" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "The people who configure your octoworld." - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "group_description": "The people who make your octoworld come to life." - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "team-sync" - } - }, - "patch": { - "summary": "Create or update IdP group connections", - "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for 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> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", - "tags": [ - "teams" - ], - "operationId": "teams/create-or-update-idp-group-connections-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections" - }, - "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": { - "groups": { - "type": "array", - "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", - "items": { - "type": "object", - "properties": { - "group_id": { - "type": "string", - "description": "ID of the IdP group." - }, - "group_name": { - "type": "string", - "description": "Name of the IdP group." - }, - "group_description": { - "type": "string", - "description": "Description of the IdP group." - } - }, - "required": [ - "group_id", - "group_name", - "group_description" - ] - } - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "string" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "GroupMapping", - "description": "External Groups to be mapped to a team for membership", - "type": "object", - "properties": { - "groups": { - "description": "Array of groups to be mapped to this team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "group_description" - ], - "properties": { - "group_id": { - "description": "The ID of the group", - "type": "string", - "examples": [ - "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa" - ] - }, - "group_name": { - "description": "The name of the group", - "type": "string", - "examples": [ - "saml-azuread-test" - ] - }, - "group_description": { - "description": "a description of the group", - "type": "string", - "examples": [ - "A group of Developers working on AzureAD SAML SSO" - ] - }, - "status": { - "description": "synchronization status for this group mapping", - "type": "string", - "examples": [ - "unsynced" - ] - }, - "synced_at": { - "description": "the time of the last sync for this group-mapping", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", - "group_name": "saml-azuread-test", - "group_description": "A group of Developers working on AzureAD SAML SSO" - }, - { - "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", - "group_name": "saml-azuread-test2", - "group_description": "Another group of Developers working on AzureAD SAML SSO" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "group_description": "The people who configure your octoworld." - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "group_description": "The people who make your octoworld come to life." - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "team-sync" - } - } - }, - "/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/enterprise-cloud@latest//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/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": "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", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - } - }, - "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-cloud@latest//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-cloud@latest//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-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "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" - ] - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { @@ -692411,1170 +690314,56 @@ "https://api.github.com/users/octocat/received_events" ] }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - } - } - } - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue_dependencies_summary": { - "title": "Issue Dependencies Summary", - "type": "object", - "properties": { - "blocked_by": { - "type": "integer" - }, - "blocking": { - "type": "integer" - }, - "total_blocked_by": { - "type": "integer" - }, - "total_blocking": { - "type": "integer" - } - }, - "required": [ - "blocked_by", - "blocking", - "total_blocked_by", - "total_blocking" - ] - }, - "issue_field_values": { - "type": "array", - "items": { - "title": "Issue Field Value", - "description": "A value assigned to an issue field", - "type": "object", - "properties": { - "issue_field_id": { - "description": "Unique identifier for the issue field.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "IFT_GDKND" - ] - }, - "data_type": { - "description": "The data type of the issue field", - "type": "string", - "enum": [ - "text", - "single_select", - "number", - "date" - ], - "examples": [ - "text" - ] - }, - "value": { - "description": "The value of the issue field", - "anyOf": [ - { - "type": "string", - "examples": [ - "Sample text" - ] - }, - { - "type": "number", - "examples": [ - 42.5 - ] - }, - { - "type": "integer", - "examples": [ - 1 - ] - } - ], - "type": [ - "null", - "string", - "number", - "integer" - ] - }, - "single_select_option": { - "description": "Details about the selected option (only present for single_select fields)", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier for the option.", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the option", - "type": "string", - "examples": [ - "High" - ] - }, - "color": { - "description": "The color of the option", - "type": "string", - "examples": [ - "red" - ] - } - }, - "required": [ - "id", - "name", - "color" - ] - } - }, - "required": [ - "issue_field_id", - "node_id", - "data_type", - "value" - ] - } - }, - "state": { - "type": "string" - }, - "state_reason": { - "type": [ - "string", - "null" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "comments": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "fragment": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "body": { - "type": "string" - }, - "score": { - "type": "number" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "draft": { - "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" + ] + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -693741,784 +690530,461 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { + } + } + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { "type": "integer" }, - "watchers": { + "completed": { "type": "integer" }, - "master_branch": { - "type": "string" + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "blocking": { + "type": "integer" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "total_blocked_by": { + "type": "integer" }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "total_blocking": { + "type": "integer" } }, "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" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] }, - "body_html": { - "type": "string" + "issue_field_values": { + "type": "array", + "items": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "IFT_GDKND" + ] + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "examples": [ + "text" + ] + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "examples": [ + "Sample text" + ] + }, + { + "type": "number", + "examples": [ + 42.5 + ] + }, + { + "type": "integer", + "examples": [ + 1 + ] + } + ], + "type": [ + "null", + "string", + "number", + "integer" + ] + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the option", + "type": "string", + "examples": [ + "High" + ] + }, + "color": { + "description": "The color of the option", + "type": "string", + "examples": [ + "red" + ] + } + }, + "required": [ + "id", + "name", + "color" + ] + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + } }, - "body_text": { + "state": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "state_reason": { "type": [ - "object", + "string", "null" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } - }, - "required": [ - "id", - "node_id", - "name", - "description" ] }, - "performed_via_github_app": { + "milestone": { "anyOf": [ { "type": "null" }, { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 37 + 1002604 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "node_id": { + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "open" ] }, - "client_id": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "v1.0" ] }, - "owner": { - "oneOf": [ + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -694662,680 +691128,118 @@ "user_view_type": { "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "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": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 280, - "incomplete_results": false, - "items": [ - { - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", - "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", - "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", - "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", - "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", - "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", - "id": 35802, - "node_id": "MDU6SXNzdWUzNTgwMg==", - "number": 132, - "title": "Line Number Indexes Beyond 20 Not Displayed", - "user": { - "login": "Nick3C", - "id": 90254, - "node_id": "MDQ6VXNlcjkwMjU0", - "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", - "gravatar_id": "", - "url": "https://api.github.com/users/Nick3C", - "html_url": "https://github.com/Nick3C", - "followers_url": "https://api.github.com/users/Nick3C/followers", - "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", - "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", - "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", - "organizations_url": "https://api.github.com/users/Nick3C/orgs", - "repos_url": "https://api.github.com/users/Nick3C/repos", - "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", - "received_events_url": "https://api.github.com/users/Nick3C/received_events", - "type": "User", - "site_admin": true - }, - "labels": [ - { - "id": 4, - "node_id": "MDU6TGFiZWw0", - "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", - "name": "bug", - "color": "ff0000" - } - ], - "state": "open", - "assignee": null, - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "comments": 15, - "created_at": "2009-07-12T20:10:41Z", - "updated_at": "2009-07-19T09:23:43Z", - "closed_at": null, - "pull_request": { - "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" - }, - "body": "...", - "score": 1, - "locked": true, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - ] - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/labels": { - "get": { - "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/labels", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" - }, - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "query", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ] - } - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Label Search Result Item", - "description": "Label Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" + "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" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "node_id": { - "type": "string" + "comments": { + "type": "integer" }, - "url": { + "created_at": { "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "color": { - "type": "string" + "format": "date-time" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "date-time" }, - "description": { + "closed_at": { "type": [ "string", "null" - ] - }, - "score": { - "type": "number" + ], + "format": "date-time" }, "text_matches": { "title": "Search Result Text Matches", @@ -695377,308 +691281,203 @@ } } } - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description", - "score" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "incomplete_results": false, - "items": [ - { - "id": 418327088, - "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", - "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", - "name": "enhancement", - "color": "84b6eb", - "default": true, - "description": "New feature or request.", - "score": 1 - }, - { - "id": 418327086, - "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", - "url": "https://api.github.com/repos/octocat/linguist/labels/bug", - "name": "bug", - "color": "ee0701", - "default": true, - "description": "Something isn't working.", - "score": 1 - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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": [ - { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" }, - { + "diff_url": { "type": [ - "integer", + "string", "null" - ] + ], + "format": "uri" }, - { + "html_url": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "search", - "subcategory": "search" - } - } - }, - "/search/repositories": { - "get": { - "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", - "tags": [ - "search" - ], - "operationId": "search/repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" - }, - "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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "stars", - "forks", - "help-wanted-issues", - "updated" - ] - } - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Repo Search Result Item", - "description": "Repo Search Result Item", - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "node_id": { + "body": { "type": "string" }, - "name": { - "type": "string" + "score": { + "type": "number" }, - "full_name": { - "type": "string" + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "draft": { + "type": "boolean" + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -695845,966 +691644,1223 @@ "type", "url" ] - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "size": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "score": { - "type": "number" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "keys_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "issue_events_url": { - "type": "string" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "assignees_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "blobs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "commits_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "archive_url": { - "type": "string" - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "issues_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "git_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "forks": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "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" - }, - "license": { - "anyOf": [ - { - "type": "null" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" }, - "maintain": { - "type": "boolean" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "push": { - "type": "boolean" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "triage": { - "type": "boolean" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 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", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "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", - "examples": [ - 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": [ - { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + 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", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - { + "created_at": { "type": [ - "integer", + "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - { + "updated_at": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "Topic Search Result Item", - "description": "Topic Search Result Item", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "display_name": { - "type": [ - "string", - "null" - ] - }, - "short_description": { - "type": [ - "string", - "null" - ] - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "created_by": { - "type": [ - "string", - "null" + }, + "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" ] }, - "released": { - "type": [ - "string", - "null" - ] + "body_html": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "body_text": { + "type": "string" }, - "updated_at": { + "timeline_url": { "type": "string", - "format": "date-time" - }, - "featured": { - "type": "boolean" - }, - "curated": { - "type": "boolean" - }, - "score": { - "type": "number" + "format": "uri" }, - "repository_count": { + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "integer", + "object", "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "logo_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "text": { + "issues": { "type": "string" }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } - } - } - } - } - } - }, - "related": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" }, - "name": { + "additionalProperties": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } - } - } - } - } - }, - "aliases": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "topic_relation": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { "type": "string" }, - "topic_id": { - "type": "integer" - }, - "relation_type": { - "type": "string" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] } - } + ] + }, + "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": [ - "name", - "display_name", - "short_description", - "description", - "created_by", - "released", + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", "updated_at", - "featured", - "curated", "score" ] } @@ -696814,436 +692870,103 @@ "examples": { "default": { "value": { - "total_count": 6, + "total_count": 280, "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//graphql/reference/queries#search).\"", - "tags": [ - "search" - ], - "operationId": "search/users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "incomplete_results", - "items" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "incomplete_results": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "title": "User Search Result Item", - "description": "User Search Result Item", - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "score": { - "type": "number" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "bio": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "location": { - "type": [ - "string", - "null" - ] - }, - "site_admin": { - "type": "boolean" - }, - "hireable": { - "type": [ - "boolean", - "null" - ] + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true }, - "text_matches": { - "title": "Search Result Text Matches", - "type": "array", - "items": { - "type": "object", - "properties": { - "object_url": { - "type": "string" - }, - "object_type": { - "type": [ - "string", - "null" - ] - }, - "property": { - "type": "string" - }, - "fragment": { - "type": "string" - }, - "matches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - } - } + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "blog": { - "type": [ - "string", - "null" - ] - }, - "company": { - "type": [ - "string", - "null" - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, - "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", + "body": "...", "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 + "locked": true, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -697252,9 +692975,6 @@ } } }, - "304": { - "description": "Not modified" - }, "503": { "description": "Service unavailable", "content": { @@ -697350,6 +693070,35 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { @@ -697360,27 +693109,81 @@ } } }, - "/teams/{team_id}": { + "/search/labels": { "get": { - "summary": "Get a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ - "teams" + "search" ], - "operationId": "teams/get-legacy", + "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels" }, "parameters": [ { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", "required": true, "schema": { "type": "integer" } + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + } + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -697389,753 +693192,146 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "node_id": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "score": { + "type": "number" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + } } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -698161,1794 +693357,1821 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", - "tags": [ - "teams" - ], - "operationId": "teams/update-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when the updated information already exists", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] + "type": "string" }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "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" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "documentation_url": { + "type": "string" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "field": { + "type": "string" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields 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/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories" + }, + "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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)\" 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 `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + } + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "total_count": { + "type": "integer" }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "incomplete_results": { + "type": "boolean" }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] - } + "items": { + "type": "array", + "items": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "type" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "pushed_at": { + "type": "string", + "format": "date-time" + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "score": { + "type": "number" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "topics": { + "type": "array", + "items": { "type": "string" + } + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "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" + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "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": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } } }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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", + "examples": [ + false + ] + } }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "ldap_dn": { - "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "examples": [ - "cn=Enterprise Ops,ou=teams,dc=github,dc=com" - ] - }, - "type": { - "description": "The ownership type of the team", - "type": "string", - "enum": [ - "enterprise", - "organization" - ] - }, - "organization_id": { - "type": "integer", - "description": "Unique identifier of the organization to which this team belongs", - "examples": [ - 37 - ] - }, - "enterprise_id": { - "type": "integer", - "description": "Unique identifier of the enterprise to which this team belongs", - "examples": [ - 42 - ] + "required": [ + "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": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { + } + } + } + } + } + }, + "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" }, - "status": { + "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "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/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "title": "Topic Search Result Item", + "description": "Topic Search Result Item", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": [ + "string", + "null" + ] + }, + "short_description": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "created_by": { + "type": [ + "string", + "null" + ] + }, + "released": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + "logo_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "related": { + "type": [ + "array", + "null" + ], + "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", + "null" + ], + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//graphql/reference/queries#search).\"", + "tags": [ + "search" + ], + "operationId": "search/users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "incomplete_results", + "items" ], "properties": { - "message": { - "type": "string" + "total_count": { + "type": "integer" }, - "documentation_url": { - "type": "string" + "incomplete_results": { + "type": "boolean" }, - "errors": { + "items": { "type": "array", "items": { + "title": "User Search Result Item", + "description": "User Search Result Item", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "login": { "type": "string" }, - "field": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string" }, - "message": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, - "code": { + "score": { + "type": "number" + }, + "following_url": { "type": "string" }, - "index": { + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "public_repos": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "bio": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "location": { + "type": [ + "string", + "null" + ] + }, + "site_admin": { + "type": "boolean" + }, + "hireable": { + "type": [ + "boolean", + "null" + ] + }, + "text_matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "type": [ + "string", + "null" + ] + }, + "property": { + "type": "string" + }, + "fragment": { "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } } } + } + }, + "blog": { + "type": [ + "string", + "null" + ] + }, + "company": { + "type": [ + "string", + "null" ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "user_view_type": { + "type": "string" } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] } } } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a team (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -700035,25 +695258,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true + "category": "search", + "subcategory": "search" + } } }, - "/teams/{team_id}/discussions": { + "/teams/{team_id}": { "get": { - "summary": "List discussions (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "Get a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-discussions-legacy", + "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -700064,38 +695284,6 @@ "schema": { "type": "integer" } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -700104,545 +695292,115 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true - } - }, - "/teams/{team_id}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], - "operationId": "teams/get-discussion-legacy", + "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -701057,548 +696096,941 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + 1 + ] + }, + "node_id": { + "type": "string", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

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

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

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

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

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

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

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

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

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -702308,11 +698208,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -702322,45 +698235,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -702418,12 +698352,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" ] @@ -702453,19 +698392,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, @@ -702498,20 +698442,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": [ { @@ -702522,15 +698466,6 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -702540,19 +698475,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." } } } @@ -702565,8 +698511,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": { @@ -702745,16 +698691,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -702764,11 +698710,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -702778,45 +698737,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -702874,12 +698854,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" ] @@ -702907,19 +698892,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, @@ -702944,22 +698934,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": [ { @@ -702979,15 +698969,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -702996,8 +698977,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": { @@ -703176,16 +699157,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -703195,11 +699176,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -703209,45 +699203,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -703305,12 +699320,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" ] @@ -703338,19 +699358,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, @@ -703374,20 +699399,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": [ { @@ -703407,37 +699432,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" } } } @@ -703450,8 +699467,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": { @@ -703630,16 +699647,16 @@ ] }, "body": { - "description": "The main text of the comment.", + "description": "The main text of the discussion.", "type": "string", "examples": [ - "I agree with this suggestion." + "Please suggest improvements to our workflow in comments." ] }, "body_html": { "type": "string", "examples": [ - "

Do you like apples?

" + "

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

" ] }, "body_version": { @@ -703649,11 +699666,24 @@ "0307116bbf7ced493b8d8a346c650b71" ] }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "last_edited_at": { @@ -703663,45 +699693,66 @@ ], "format": "date-time" }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, "node_id": { "type": "string", "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, "number": { - "description": "The unique sequence number of a team discussion comment.", + "description": "The unique sequence number of a team discussion.", "type": "integer", "examples": [ 42 ] }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" + ] + }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-15T23:53:58Z" + "2018-01-25T18:56:31Z" ] }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, "reactions": { @@ -703759,12 +699810,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" ] @@ -703792,19 +699848,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, @@ -703828,20 +699889,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": [ { @@ -703861,15 +699922,6 @@ "schema": { "type": "integer" } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -703883,22 +699935,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": [ { @@ -703920,31 +699972,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" } }, { @@ -703974,23 +700012,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -704165,104 +700191,678 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" + "eyes", + "rocket" ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + } + } + } + }, + "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": "discussion-comments" + }, + "deprecated": true + }, + "post": { + "summary": "Create a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/create-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy" + }, + "parameters": [ + { + "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": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like apples?" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } + "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": { + "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 - }, - "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.", + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-legacy", + "operationId": "teams/get-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#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -704293,65 +700893,17 @@ } } ], - "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": { + "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -704526,45 +701078,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -704584,8 +701241,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 + } } } } @@ -704596,25 +701274,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 - } - }, - "/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.", + }, + "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/list-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#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -704636,354 +701312,8 @@ } }, { - "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", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" - } - ] - } - } - } - }, - "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" - }, - "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": [ - { - "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.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -704998,29 +701328,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?" } } } @@ -705028,28 +701348,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -705224,45 +701532,150 @@ } ] }, - "content": { - "description": "The reaction to use", + "body": { + "description": "The main text of the comment.", "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], "examples": [ - "heart" + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "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=", @@ -705282,8 +701695,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 + } } } } @@ -705293,11 +701727,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-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index b60759a91..af0c57cf6 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -13533,7 +13533,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &521 + instances_url: &517 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13569,7 +13569,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &522 + dismissed_reason: &518 type: - string - 'null' @@ -13580,14 +13580,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &523 + dismissed_comment: &519 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &524 + rule: &520 type: object properties: id: @@ -13648,7 +13648,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &525 + tool: &521 type: object properties: name: *109 @@ -13659,26 +13659,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &526 + most_recent_instance: &522 type: object properties: - ref: &519 + ref: &515 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &536 + analysis_key: &532 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: &537 + environment: &533 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: &538 + category: &534 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13692,7 +13692,7 @@ paths: properties: text: type: string - location: &539 + location: &535 type: object description: Describe a region within a file for the alert. properties: @@ -13713,7 +13713,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &540 + items: &536 type: - string - 'null' @@ -17487,7 +17487,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &575 + - &573 name: has in: query description: |- @@ -17604,7 +17604,7 @@ paths: - direct - transitive - - security_advisory: &576 + security_advisory: &574 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17840,7 +17840,7 @@ paths: dismissal. maxLength: 280 fixed_at: *133 - auto_dismissed_at: &577 + auto_dismissed_at: &575 type: - string - 'null' @@ -17848,7 +17848,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &578 + dismissal_request: &576 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -26631,7 +26631,7 @@ paths: action: type: string issue: *212 - comment: &635 + comment: &633 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -31384,14 +31384,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &448 + - &444 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &449 + - &445 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -31453,7 +31453,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &454 + '301': &450 description: Moved permanently content: application/json: @@ -34107,7 +34107,7 @@ paths: type: integer repository_cache_usages: type: array - items: &461 + items: &457 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -37274,7 +37274,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &477 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -37309,7 +37309,7 @@ paths: - key_id - key examples: - default: &482 + default: &478 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -37722,7 +37722,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *85 - - &466 + - &462 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)." @@ -39368,7 +39368,7 @@ paths: initiator: type: string examples: - default: &495 + default: &491 value: attestations: - bundle: @@ -40290,7 +40290,7 @@ paths: be returned. in: query required: false - schema: &520 + schema: &516 type: string description: Severity of a code scanning alert. enum: @@ -41349,7 +41349,7 @@ paths: machine: anyOf: - type: 'null' - - &552 + - &548 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -42301,7 +42301,7 @@ paths: - updated_at - visibility examples: - default: &553 + default: &549 value: total_count: 2 secrets: @@ -42339,7 +42339,7 @@ paths: description: Response content: application/json: - schema: &554 + schema: &550 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -42374,7 +42374,7 @@ paths: - key_id - key examples: - default: &555 + default: &551 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42406,7 +42406,7 @@ paths: application/json: schema: *316 examples: - default: &557 + default: &553 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44285,7 +44285,7 @@ paths: description: Response content: application/json: - schema: &581 + schema: &579 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -44304,7 +44304,7 @@ paths: - key_id - key examples: - default: &582 + default: &580 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44634,7 +44634,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *85 - - &590 + - &588 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -44642,7 +44642,7 @@ paths: required: false schema: type: string - - &591 + - &589 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -44650,7 +44650,7 @@ paths: required: false schema: type: string - - &592 + - &590 name: time_period description: |- The time period to filter by. @@ -44666,7 +44666,7 @@ paths: - week - month default: month - - &593 + - &591 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -44691,7 +44691,7 @@ paths: application/json: schema: type: array - items: &594 + items: &592 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -44854,7 +44854,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &595 + default: &593 value: - id: 21 number: 42 @@ -44972,7 +44972,7 @@ paths: application/json: schema: type: array - items: &596 + items: &594 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -45095,7 +45095,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &597 + default: &595 value: - id: 21 number: 42 @@ -45197,7 +45197,7 @@ paths: application/json: schema: type: array - items: &598 + items: &596 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -45324,7 +45324,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &599 + default: &597 value: - id: 21 number: 42 @@ -45670,7 +45670,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &441 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -45760,7 +45760,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &446 + default: &442 value: group_id: '123' group_name: Octocat admins @@ -45815,7 +45815,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &439 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -45855,7 +45855,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &444 + default: &440 value: groups: - group_id: '123' @@ -47184,7 +47184,7 @@ paths: application/json: schema: *20 examples: - default: &630 + default: &628 value: id: 1 account: @@ -47412,7 +47412,7 @@ paths: required: true content: application/json: - schema: &631 + schema: &629 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -48280,7 +48280,7 @@ paths: application/json: schema: *363 examples: - default: &551 + default: &547 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -53029,7 +53029,7 @@ paths: content: oneOf: - *212 - - &564 + - &562 title: Pull Request Simple description: Pull Request Simple type: object @@ -55936,7 +55936,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &449 title: Full Repository description: Full Repository type: object @@ -56401,7 +56401,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &569 + code_of_conduct: &567 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -56515,7 +56515,7 @@ paths: - network_count - subscribers_count examples: - default: &455 + default: &451 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -59431,7 +59431,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &446 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -59483,7 +59483,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &451 + default: &447 value: groups: - group_id: '123' @@ -61185,408 +61185,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: - - *85 - - *209 - - *435 - - *438 - - 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: &439 - 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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - *4 - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &441 - 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: *45 - 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: - - *85 - - *209 - - *435 - - *438 - 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: *439 - examples: - default: &440 - 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: *439 - examples: - default: *440 - 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: - - *85 - - *209 - - *435 - - *438 - - &442 - 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: - - *85 - - *209 - - *435 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *85 - - *209 - - *435 - 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: *439 - examples: - default: *440 - '201': - description: Response - content: - application/json: - schema: *439 - examples: - default: *440 - 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: - - *85 - - *209 - - *435 - - *442 - 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 @@ -61608,9 +61206,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *439 examples: - default: *444 + default: *440 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -61654,9 +61252,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *441 examples: - default: *446 + default: *442 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61797,7 +61395,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &443 title: Team Membership description: Team Membership type: object @@ -61888,7 +61486,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-users-membership-with-team-is-now-pending: &779 summary: Response if user's membership with team is now pending @@ -61997,8 +61595,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Alternative response with repository permissions @@ -62647,8 +62245,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -62695,8 +62293,8 @@ paths: parameters: - *85 - *209 - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -62729,9 +62327,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: - default: *451 + default: *447 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62797,7 +62395,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: default: value: @@ -62996,7 +62594,7 @@ paths: resources: type: object properties: - core: &452 + core: &448 title: Rate Limit type: object properties: @@ -63013,21 +62611,21 @@ paths: - remaining - reset - used - graphql: *452 - search: *452 - code_search: *452 - source_import: *452 - integration_manifest: *452 - code_scanning_upload: *452 - actions_runner_registration: *452 - scim: *452 - dependency_snapshots: *452 - dependency_sbom: *452 - code_scanning_autofix: *452 + graphql: *448 + search: *448 + code_search: *448 + source_import: *448 + integration_manifest: *448 + code_scanning_upload: *448 + actions_runner_registration: *448 + scim: *448 + dependency_snapshots: *448 + dependency_sbom: *448 + code_scanning_autofix: *448 required: - core - search - rate: *452 + rate: *448 required: - rate - resources @@ -63132,14 +62730,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *453 + schema: *449 examples: default-response: summary: Default response @@ -63644,7 +63242,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *454 + '301': *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63662,8 +63260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -63921,10 +63519,10 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 - '307': &456 + default: *451 + '307': &452 description: Temporary Redirect content: application/json: @@ -63953,8 +63551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -63976,7 +63574,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': *456 + '307': *452 '404': *6 '409': *116 x-github: @@ -64000,11 +63598,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - - &473 + - &469 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -64027,7 +63625,7 @@ paths: type: integer artifacts: type: array - items: &457 + items: &453 title: Artifact description: An artifact type: object @@ -64122,7 +63720,7 @@ paths: - expires_at - updated_at examples: - default: &474 + default: &470 value: total_count: 2 artifacts: @@ -64183,9 +63781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *448 - - *449 - - &458 + - *444 + - *445 + - &454 name: artifact_id description: The unique identifier of the artifact. in: path @@ -64197,7 +63795,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *453 examples: default: value: @@ -64235,9 +63833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *448 - - *449 - - *458 + - *444 + - *445 + - *454 responses: '204': description: Response @@ -64261,9 +63859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *448 - - *449 - - *458 + - *444 + - *445 + - *454 - name: archive_format in: path required: true @@ -64277,7 +63875,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': &634 + '410': &632 description: Gone content: application/json: @@ -64302,14 +63900,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &459 + schema: &455 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -64343,13 +63941,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *459 + schema: *455 examples: selected_actions: *42 responses: @@ -64378,14 +63976,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &460 + schema: &456 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -64419,13 +64017,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *460 + schema: *456 examples: selected_actions: *44 responses: @@ -64456,14 +64054,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *461 + schema: *457 examples: default: value: @@ -64489,11 +64087,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: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - - &462 + - &458 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 @@ -64527,7 +64125,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &459 title: Repository actions caches description: Repository actions caches type: object @@ -64577,7 +64175,7 @@ paths: - total_count - actions_caches examples: - default: &464 + default: &460 value: total_count: 1 actions_caches: @@ -64609,23 +64207,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: - - *448 - - *449 + - *444 + - *445 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *462 + - *458 responses: '200': description: Response content: application/json: - schema: *463 + schema: *459 examples: - default: *464 + default: *460 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64645,8 +64243,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: - - *448 - - *449 + - *444 + - *445 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -64677,9 +64275,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: - - *448 - - *449 - - &465 + - *444 + - *445 + - &461 name: job_id description: The unique identifier of the job. in: path @@ -64691,7 +64289,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &473 title: Job description: Information of a job execution in a workflow run type: object @@ -65038,9 +64636,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: - - *448 - - *449 - - *465 + - *444 + - *445 + - *461 responses: '302': description: Response @@ -65068,9 +64666,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: - - *448 - - *449 - - *465 + - *444 + - *445 + - *461 requestBody: required: false content: @@ -65116,8 +64714,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Status response @@ -65167,8 +64765,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -65231,8 +64829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -65250,7 +64848,7 @@ paths: type: integer secrets: type: array - items: &479 + items: &475 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -65271,7 +64869,7 @@ paths: - created_at - updated_at examples: - default: &480 + default: &476 value: total_count: 2 secrets: @@ -65304,9 +64902,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *448 - - *449 - - *466 + - *444 + - *445 + - *462 - *19 responses: '200': @@ -65323,7 +64921,7 @@ paths: type: integer variables: type: array - items: &483 + items: &479 title: Actions Variable type: object properties: @@ -65357,7 +64955,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &480 value: total_count: 2 variables: @@ -65390,8 +64988,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65400,7 +64998,7 @@ paths: schema: type: object properties: - enabled: &467 + enabled: &463 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *58 @@ -65435,8 +65033,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65447,7 +65045,7 @@ paths: schema: type: object properties: - enabled: *467 + enabled: *463 allowed_actions: *58 sha_pinning_required: *59 required: @@ -65480,14 +65078,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &468 + schema: &464 type: object properties: access_level: @@ -65505,7 +65103,7 @@ paths: required: - access_level examples: - default: &469 + default: &465 value: access_level: organization x-github: @@ -65530,15 +65128,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *468 + schema: *464 examples: - default: *469 + default: *465 responses: '204': description: Response @@ -65562,8 +65160,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65593,8 +65191,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Empty response for successful settings update @@ -65628,8 +65226,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65656,8 +65254,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65691,8 +65289,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65720,8 +65318,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -65752,8 +65350,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65784,8 +65382,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -65817,8 +65415,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65847,8 +65445,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Success response @@ -65888,8 +65486,8 @@ paths: in: query schema: type: string - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -65933,8 +65531,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -65966,8 +65564,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -66041,8 +65639,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: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -66078,8 +65676,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: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -66109,8 +65707,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': @@ -66140,8 +65738,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '204': @@ -66168,8 +65766,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': *79 @@ -66194,8 +65792,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: - - *448 - - *449 + - *444 + - *445 - *73 requestBody: required: true @@ -66244,8 +65842,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: - - *448 - - *449 + - *444 + - *445 - *73 requestBody: required: true @@ -66295,8 +65893,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: - - *448 - - *449 + - *444 + - *445 - *73 responses: '200': *279 @@ -66326,8 +65924,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: - - *448 - - *449 + - *444 + - *445 - *73 - *280 responses: @@ -66357,9 +65955,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: - - *448 - - *449 - - &487 + - *444 + - *445 + - &483 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. @@ -66367,7 +65965,7 @@ paths: required: false schema: type: string - - &488 + - &484 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -66375,7 +65973,7 @@ paths: required: false schema: type: string - - &489 + - &485 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -66384,7 +65982,7 @@ paths: required: false schema: type: string - - &490 + - &486 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 @@ -66411,7 +66009,7 @@ paths: - pending - *17 - *19 - - &491 + - &487 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)." @@ -66420,7 +66018,7 @@ paths: schema: type: string format: date-time - - &470 + - &466 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -66429,13 +66027,13 @@ paths: schema: type: boolean default: false - - &492 + - &488 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &493 + - &489 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -66458,7 +66056,7 @@ paths: type: integer workflow_runs: type: array - items: &471 + items: &467 title: Workflow Run description: An invocation of a workflow type: object @@ -66636,7 +66234,7 @@ paths: head_commit: anyOf: - type: 'null' - - &515 + - &511 title: Simple Commit description: A commit. type: object @@ -66751,7 +66349,7 @@ paths: - workflow_url - pull_requests examples: - default: &494 + default: &490 value: total_count: 1 workflow_runs: @@ -66987,24 +66585,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *448 - - *449 - - &472 + - *444 + - *445 + - &468 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *470 + - *466 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: &475 + default: &471 value: id: 30433642 name: Build @@ -67245,9 +66843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '204': description: Response @@ -67270,9 +66868,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -67400,9 +66998,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '201': description: Response @@ -67435,12 +67033,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 - *17 - *19 - - *473 + - *469 responses: '200': description: Response @@ -67456,9 +67054,9 @@ paths: type: integer artifacts: type: array - items: *457 + items: *453 examples: - default: *474 + default: *470 headers: Link: *45 x-github: @@ -67482,25 +67080,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *448 - - *449 - - *472 - - &476 + - *444 + - *445 + - *468 + - &472 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *470 + - *466 responses: '200': description: Response content: application/json: - schema: *471 + schema: *467 examples: - default: *475 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67523,10 +67121,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: - - *448 - - *449 + - *444 + - *445 + - *468 - *472 - - *476 - *17 - *19 responses: @@ -67544,9 +67142,9 @@ paths: type: integer jobs: type: array - items: *477 + items: *473 examples: - default: &478 + default: &474 value: total_count: 1 jobs: @@ -67659,10 +67257,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *448 - - *449 + - *444 + - *445 + - *468 - *472 - - *476 responses: '302': description: Response @@ -67690,9 +67288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '202': description: Response @@ -67725,9 +67323,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: true content: @@ -67794,9 +67392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '202': description: Response @@ -67829,9 +67427,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 - 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 @@ -67861,9 +67459,9 @@ paths: type: integer jobs: type: array - items: *477 + items: *473 examples: - default: *478 + default: *474 headers: Link: *45 x-github: @@ -67888,9 +67486,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '302': description: Response @@ -67917,9 +67515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '204': description: Response @@ -67946,9 +67544,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -68017,7 +67615,7 @@ paths: items: type: object properties: - type: &600 + type: &598 type: string description: The type of reviewer. enum: @@ -68103,9 +67701,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: true content: @@ -68155,7 +67753,7 @@ paths: application/json: schema: type: array - items: &585 + items: &583 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -68267,7 +67865,7 @@ paths: - created_at - updated_at examples: - default: &586 + default: &584 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -68323,9 +67921,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: false content: @@ -68370,9 +67968,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: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 requestBody: required: false content: @@ -68427,9 +68025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *448 - - *449 - - *472 + - *444 + - *445 + - *468 responses: '200': description: Response @@ -68566,8 +68164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -68585,9 +68183,9 @@ paths: type: integer secrets: type: array - items: *479 + items: *475 examples: - default: *480 + default: *476 headers: Link: *45 x-github: @@ -68612,16 +68210,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68643,17 +68241,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: - default: &613 + default: &611 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -68679,8 +68277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -68738,8 +68336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -68765,9 +68363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *448 - - *449 - - *466 + - *444 + - *445 + - *462 - *19 responses: '200': @@ -68784,9 +68382,9 @@ paths: type: integer variables: type: array - items: *483 + items: *479 examples: - default: *484 + default: *480 headers: Link: *45 x-github: @@ -68809,8 +68407,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -68862,17 +68460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *479 examples: - default: &614 + default: &612 value: name: USERNAME value: octocat @@ -68898,8 +68496,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 requestBody: required: true @@ -68942,8 +68540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 responses: '204': @@ -68969,8 +68567,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -68988,7 +68586,7 @@ paths: type: integer workflows: type: array - items: &485 + items: &481 title: Workflow description: A GitHub Actions workflow type: object @@ -69106,9 +68704,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *448 - - *449 - - &486 + - *444 + - *445 + - &482 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -69123,7 +68721,7 @@ paths: description: Response content: application/json: - schema: *485 + schema: *481 examples: default: value: @@ -69156,9 +68754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69183,9 +68781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69236,9 +68834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '204': description: Response @@ -69265,19 +68863,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: - - *448 - - *449 + - *444 + - *445 + - *482 + - *483 + - *484 + - *485 - *486 + - *17 + - *19 - *487 + - *466 - *488 - *489 - - *490 - - *17 - - *19 - - *491 - - *470 - - *492 - - *493 responses: '200': description: Response @@ -69293,9 +68891,9 @@ paths: type: integer workflow_runs: type: array - items: *471 + items: *467 examples: - default: *494 + default: *490 headers: Link: *45 x-github: @@ -69328,9 +68926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *448 - - *449 - - *486 + - *444 + - *445 + - *482 responses: '200': description: Response @@ -69391,8 +68989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *448 - - *449 + - *444 + - *445 - *108 - *17 - *106 @@ -69560,8 +69158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -69598,8 +69196,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: - - *448 - - *449 + - *444 + - *445 - name: assignee in: path required: true @@ -69635,8 +69233,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -69748,8 +69346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *106 - *107 @@ -69806,7 +69404,7 @@ paths: initiator: type: string examples: - default: *495 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69826,8 +69424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -69835,7 +69433,7 @@ paths: application/json: schema: type: array - items: &496 + items: &492 title: Autolink reference description: An autolink reference. type: object @@ -69894,8 +69492,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -69934,9 +69532,9 @@ paths: description: response content: application/json: - schema: *496 + schema: *492 examples: - default: &497 + default: &493 value: id: 1 key_prefix: TICKET- @@ -69967,9 +69565,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: - - *448 - - *449 - - &498 + - *444 + - *445 + - &494 name: autolink_id description: The unique identifier of the autolink. in: path @@ -69981,9 +69579,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *492 examples: - default: *497 + default: *493 '404': *6 x-github: githubCloudOnly: false @@ -70003,9 +69601,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: - - *448 - - *449 - - *498 + - *444 + - *445 + - *494 responses: '204': description: Response @@ -70029,8 +69627,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response if Dependabot is enabled @@ -70080,8 +69678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -70102,8 +69700,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -70123,8 +69721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *448 - - *449 + - *444 + - *445 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -70162,7 +69760,7 @@ paths: - url protected: type: boolean - protection: &500 + protection: &496 title: Branch Protection description: Branch Protection type: object @@ -70205,7 +69803,7 @@ paths: required: - contexts - checks - enforce_admins: &503 + enforce_admins: &499 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -70222,7 +69820,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &505 + required_pull_request_reviews: &501 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -70306,7 +69904,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &502 + restrictions: &498 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -70599,9 +70197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *448 - - *449 - - &501 + - *444 + - *445 + - &497 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). @@ -70615,14 +70213,14 @@ paths: description: Response content: application/json: - schema: &511 + schema: &507 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &560 + commit: &558 title: Commit description: Commit type: object @@ -70661,7 +70259,7 @@ paths: author: anyOf: - type: 'null' - - &499 + - &495 title: Git User description: Metaproperties for Git author/committer information. @@ -70683,7 +70281,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 message: type: string examples: @@ -70707,7 +70305,7 @@ paths: required: - sha - url - verification: &620 + verification: &618 title: Verification type: object properties: @@ -70787,7 +70385,7 @@ paths: type: integer files: type: array - items: &571 + items: &569 title: Diff Entry description: Diff Entry type: object @@ -70883,7 +70481,7 @@ paths: - self protected: type: boolean - protection: *500 + protection: *496 protection_url: type: string format: uri @@ -70992,7 +70590,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *454 + '301': *450 '404': *6 x-github: githubCloudOnly: false @@ -71014,15 +70612,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *500 + schema: *496 examples: default: value: @@ -71216,9 +70814,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -71478,7 +71076,7 @@ paths: url: type: string format: uri - required_status_checks: &508 + required_status_checks: &504 title: Status Check Policy description: Status Check Policy type: object @@ -71637,7 +71235,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *502 + restrictions: *498 required_conversation_resolution: type: object properties: @@ -71749,9 +71347,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -71776,17 +71374,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: &504 + default: &500 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -71808,17 +71406,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: *504 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71837,9 +71435,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -71864,17 +71462,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *505 + schema: *501 examples: - default: &506 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -71970,9 +71568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72070,9 +71668,9 @@ paths: description: Response content: application/json: - schema: *505 + schema: *501 examples: - default: *506 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -72093,9 +71691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72122,17 +71720,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: &507 + default: &503 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -72155,17 +71753,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *503 + schema: *499 examples: - default: *507 + default: *503 '404': *6 x-github: githubCloudOnly: false @@ -72185,9 +71783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72212,17 +71810,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *508 + schema: *504 examples: - default: &509 + default: &505 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -72248,9 +71846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72302,9 +71900,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *504 examples: - default: *509 + default: *505 '404': *6 '422': *15 x-github: @@ -72326,9 +71924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72352,9 +71950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72388,9 +71986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72457,9 +72055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -72523,9 +72121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: content: application/json: @@ -72591,15 +72189,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response content: application/json: - schema: *502 + schema: *498 examples: default: value: @@ -72690,9 +72288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '204': description: Response @@ -72715,9 +72313,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72727,7 +72325,7 @@ paths: type: array items: *5 examples: - default: &510 + default: &506 value: - id: 1 slug: octoapp @@ -72784,9 +72382,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72820,7 +72418,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72841,9 +72439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72877,7 +72475,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72898,9 +72496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -72934,7 +72532,7 @@ paths: type: array items: *5 examples: - default: *510 + default: *506 '422': *15 x-github: githubCloudOnly: false @@ -72956,9 +72554,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -72988,9 +72586,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -73049,9 +72647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: false content: @@ -73110,9 +72708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: content: application/json: @@ -73171,9 +72769,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: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 responses: '200': description: Response @@ -73207,9 +72805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73267,9 +72865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73327,9 +72925,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73389,9 +72987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 requestBody: required: true content: @@ -73413,7 +73011,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *507 examples: default: value: @@ -73527,8 +73125,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -73564,8 +73162,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73638,8 +73236,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -73679,8 +73277,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73750,8 +73348,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_request_number in: path required: true @@ -73822,8 +73420,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *444 + - *445 - name: bypass_response_id in: path required: true @@ -73856,8 +73454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -74136,7 +73734,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &508 title: CheckRun description: A check performed on the code of a given code change type: object @@ -74559,9 +74157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *448 - - *449 - - &513 + - *444 + - *445 + - &509 name: check_run_id description: The unique identifier of the check run. in: path @@ -74573,9 +74171,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *508 examples: - default: &514 + default: &510 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -74675,9 +74273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 requestBody: required: true content: @@ -74917,9 +74515,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *508 examples: - default: *514 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74939,9 +74537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 - *17 - *19 responses: @@ -75051,9 +74649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *448 - - *449 - - *513 + - *444 + - *445 + - *509 responses: '201': description: Response @@ -75097,8 +74695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -75120,7 +74718,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &516 + schema: &512 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -75218,7 +74816,7 @@ paths: - string - 'null' format: date-time - head_commit: *515 + head_commit: *511 latest_check_runs_count: type: integer check_runs_url: @@ -75246,7 +74844,7 @@ paths: - check_runs_url - pull_requests examples: - default: &517 + default: &513 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -75537,9 +75135,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *516 + schema: *512 examples: - default: *517 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75558,8 +75156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -75868,9 +75466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *448 - - *449 - - &518 + - *444 + - *445 + - &514 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -75882,9 +75480,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *512 examples: - default: *517 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75907,17 +75505,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: - - *448 - - *449 - - *518 - - &566 + - *444 + - *445 + - *514 + - &564 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &567 + - &565 name: status description: Returns check runs with the specified `status`. in: query @@ -75956,9 +75554,9 @@ paths: type: integer check_runs: type: array - items: *512 + items: *508 examples: - default: &568 + default: &566 value: total_count: 1 check_runs: @@ -76060,9 +75658,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *448 - - *449 - - *518 + - *444 + - *445 + - *514 responses: '201': description: Response @@ -76095,21 +75693,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: - - *448 - - *449 + - *444 + - *445 - *305 - *306 - *19 - *17 - - &534 + - &530 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: *519 - - &535 + schema: *515 + - &531 name: pr description: The number of the pull request for the results you want to list. in: query @@ -76140,7 +75738,7 @@ paths: be returned. in: query required: false - schema: *520 + schema: *516 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -76164,7 +75762,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *521 + instances_url: *517 state: *111 fixed_at: *133 dismissed_by: @@ -76172,11 +75770,11 @@ paths: - type: 'null' - *4 dismissed_at: *132 - dismissed_reason: *522 - dismissed_comment: *523 - rule: *524 - tool: *525 - most_recent_instance: *526 + dismissed_reason: *518 + dismissed_comment: *519 + rule: *520 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -76299,7 +75897,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &527 + '403': &523 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -76326,9 +75924,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: - - *448 - - *449 - - &528 + - *444 + - *445 + - &524 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -76342,7 +75940,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &525 type: object properties: number: *123 @@ -76350,7 +75948,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *521 + instances_url: *517 state: *111 fixed_at: *133 dismissed_by: @@ -76358,8 +75956,8 @@ paths: - type: 'null' - *4 dismissed_at: *132 - dismissed_reason: *522 - dismissed_comment: *523 + dismissed_reason: *518 + dismissed_comment: *519 rule: type: object properties: @@ -76421,8 +76019,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *525 - most_recent_instance: *526 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -76518,7 +76116,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -76538,9 +76136,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: true content: @@ -76555,8 +76153,8 @@ paths: enum: - open - dismissed - dismissed_reason: *522 - dismissed_comment: *523 + dismissed_reason: *518 + dismissed_comment: *519 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -76584,7 +76182,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *525 examples: default: value: @@ -76660,7 +76258,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &533 + '403': &529 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -76687,15 +76285,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 responses: '200': description: Response content: application/json: - schema: &530 + schema: &526 type: object properties: status: @@ -76722,13 +76320,13 @@ paths: - description - started_at examples: - default: &531 + default: &527 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &532 + '400': &528 description: Bad Request content: application/json: @@ -76739,7 +76337,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': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -76764,29 +76362,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 responses: '200': description: OK content: application/json: - schema: *530 + schema: *526 examples: - default: *531 + default: *527 '202': description: Accepted content: application/json: - schema: *530 + schema: *526 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *532 + '400': *528 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -76818,9 +76416,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: false content: @@ -76866,8 +76464,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *532 - '403': *533 + '400': *528 + '403': *529 '404': *6 '422': description: Unprocessable Entity @@ -76891,13 +76489,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *19 - *17 - - *534 - - *535 + - *530 + - *531 responses: '200': description: Response @@ -76908,10 +76506,10 @@ paths: items: type: object properties: - ref: *519 - analysis_key: *536 - environment: *537 - category: *538 + ref: *515 + analysis_key: *532 + environment: *533 + category: *534 state: type: - string @@ -76928,7 +76526,7 @@ paths: properties: text: type: string - location: *539 + location: *535 html_url: type: string classifications: @@ -76936,7 +76534,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: *540 + items: *536 examples: default: value: @@ -76975,7 +76573,7 @@ paths: end_column: 50 classifications: - source - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77009,25 +76607,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: - - *448 - - *449 + - *444 + - *445 - *305 - *306 - *19 - *17 - - *535 + - *531 - 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: *519 + schema: *515 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &541 + schema: &537 type: string description: An identifier for the upload. examples: @@ -77049,23 +76647,23 @@ paths: application/json: schema: type: array - items: &542 + items: &538 type: object properties: - ref: *519 - commit_sha: &550 + ref: *515 + commit_sha: &546 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: *536 + analysis_key: *532 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *538 + category: *534 error: type: string examples: @@ -77090,8 +76688,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *541 - tool: *525 + sarif_id: *537 + tool: *521 deletable: type: boolean warning: @@ -77153,7 +76751,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77189,8 +76787,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: - - *448 - - *449 + - *444 + - *445 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77203,7 +76801,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *538 examples: response: summary: application/json response @@ -77257,7 +76855,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *527 + '403': *523 '404': *6 '422': description: Response if analysis could not be processed @@ -77344,8 +76942,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: - - *448 - - *449 + - *444 + - *445 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -77401,7 +76999,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': *533 + '403': *529 '404': *6 '503': *189 x-github: @@ -77423,8 +77021,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -77432,7 +77030,7 @@ paths: application/json: schema: type: array - items: &543 + items: &539 title: CodeQL Database description: A CodeQL database. type: object @@ -77544,7 +77142,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': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77573,8 +77171,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: - - *448 - - *449 + - *444 + - *445 - name: language in: path description: The language of the CodeQL database. @@ -77586,7 +77184,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *539 examples: default: value: @@ -77618,9 +77216,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': &573 + '302': &571 description: Found - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -77642,8 +77240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *448 - - *449 + - *444 + - *445 - name: language in: path description: The language of the CodeQL database. @@ -77653,7 +77251,7 @@ paths: responses: '204': description: Response - '403': *533 + '403': *529 '404': *6 '503': *189 x-github: @@ -77681,8 +77279,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -77691,7 +77289,7 @@ paths: type: object additionalProperties: false properties: - language: &544 + language: &540 type: string description: The language targeted by the CodeQL query enum: @@ -77771,7 +77369,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &548 + schema: &544 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -77781,7 +77379,7 @@ paths: description: The ID of the variant analysis. controller_repo: *117 actor: *4 - query_language: *544 + query_language: *540 query_pack_url: type: string description: The download url for the query pack. @@ -77829,7 +77427,7 @@ paths: items: type: object properties: - repository: &545 + repository: &541 title: Repository Identifier description: Repository Identifier type: object @@ -77871,7 +77469,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &549 + analysis_status: &545 type: string description: The new status of the CodeQL variant analysis repository task. @@ -77903,7 +77501,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &546 + access_mismatch_repos: &542 type: object properties: repository_count: @@ -77918,7 +77516,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: *545 + items: *541 required: - repository_count - repositories @@ -77941,8 +77539,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *546 - over_limit_repos: *546 + no_codeql_db_repos: *542 + over_limit_repos: *542 required: - access_mismatch_repos - not_found_repos @@ -77958,7 +77556,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &547 + value: &543 summary: Default response value: id: 1 @@ -78104,10 +77702,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *547 + value: *543 repository_lists: summary: Response for a successful variant analysis submission - value: *547 + value: *543 '404': *6 '422': description: Unable to process variant analysis submission @@ -78135,8 +77733,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: - - *448 - - *449 + - *444 + - *445 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -78148,9 +77746,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *544 examples: - default: *547 + default: *543 '404': *6 '503': *189 x-github: @@ -78173,7 +77771,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: - - *448 + - *444 - name: repo in: path description: The name of the controller repository. @@ -78208,7 +77806,7 @@ paths: type: object properties: repository: *117 - analysis_status: *549 + analysis_status: *545 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -78333,8 +77931,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -78427,7 +78025,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *527 + '403': *523 '404': *6 '503': *189 x-github: @@ -78448,8 +78046,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -78543,7 +78141,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *533 + '403': *529 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -78614,8 +78212,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -78623,7 +78221,7 @@ paths: schema: type: object properties: - commit_sha: *550 + commit_sha: *546 ref: type: string description: |- @@ -78683,7 +78281,7 @@ paths: schema: type: object properties: - id: *541 + id: *537 url: type: string description: The REST API URL for checking the status of the upload. @@ -78697,7 +78295,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': *533 + '403': *529 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -78720,8 +78318,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: - - *448 - - *449 + - *444 + - *445 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -78769,7 +78367,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': *527 + '403': *523 '404': description: Not Found if the sarif id does not match any upload '503': *189 @@ -78794,8 +78392,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -78876,8 +78474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *448 - - *449 + - *444 + - *445 - 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 @@ -79005,8 +78603,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -79320,8 +78918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -79387,7 +78985,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -79395,7 +78993,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '400': *14 '401': *23 '403': *27 @@ -79424,8 +79022,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -79489,8 +79087,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: - - *448 - - *449 + - *444 + - *445 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -79527,7 +79125,7 @@ paths: type: integer machines: type: array - items: *552 + items: *548 examples: default: &788 value: @@ -79569,8 +79167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *448 - - *449 + - *444 + - *445 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -79657,8 +79255,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: - - *448 - - *449 + - *444 + - *445 - 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 @@ -79727,8 +79325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -79746,7 +79344,7 @@ paths: type: integer secrets: type: array - items: &556 + items: &552 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -79767,7 +79365,7 @@ paths: - created_at - updated_at examples: - default: *553 + default: *549 headers: Link: *45 x-github: @@ -79790,16 +79388,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *554 + schema: *550 examples: - default: *555 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -79819,17 +79417,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *556 + schema: *552 examples: - default: *557 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79849,8 +79447,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: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -79903,8 +79501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -79933,8 +79531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *448 - - *449 + - *444 + - *445 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -79972,7 +79570,7 @@ paths: application/json: schema: type: array - items: &558 + items: &554 title: Collaborator description: Collaborator type: object @@ -80165,8 +79763,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: - - *448 - - *449 + - *444 + - *445 - *136 responses: '204': @@ -80213,8 +79811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *448 - - *449 + - *444 + - *445 - *136 requestBody: required: false @@ -80241,7 +79839,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &633 + schema: &631 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -80469,8 +80067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *448 - - *449 + - *444 + - *445 - *136 responses: '204': @@ -80502,8 +80100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *448 - - *449 + - *444 + - *445 - *136 responses: '200': @@ -80524,7 +80122,7 @@ paths: user: anyOf: - type: 'null' - - *558 + - *554 required: - permission - role_name @@ -80578,8 +80176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -80589,7 +80187,7 @@ paths: application/json: schema: type: array - items: &559 + items: &555 title: Commit Comment description: Commit Comment type: object @@ -80647,7 +80245,7 @@ paths: - created_at - updated_at examples: - default: &562 + default: &560 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80706,17 +80304,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': description: Response content: application/json: - schema: *559 + schema: *555 examples: - default: &563 + default: &561 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80773,8 +80371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -80797,7 +80395,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *555 examples: default: value: @@ -80848,8 +80446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -80871,8 +80469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -80899,9 +80497,75 @@ paths: application/json: schema: type: array - items: *439 + items: &556 + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - *4 + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at examples: - default: *441 + default: &635 + 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: *45 '404': *6 @@ -80922,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -80956,16 +80620,40 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: &557 + 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: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -80987,10 +80675,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - &636 + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer responses: '204': description: Response @@ -81039,8 +80733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *448 - - *449 + - *444 + - *445 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -81096,7 +80790,7 @@ paths: application/json: schema: type: array - items: *560 + items: *558 examples: default: &682 value: @@ -81192,9 +80886,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *448 - - *449 - - &561 + - *444 + - *445 + - &559 name: commit_sha description: The SHA of the commit. in: path @@ -81266,9 +80960,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 - *17 - *19 responses: @@ -81278,9 +80972,9 @@ paths: application/json: schema: type: array - items: *559 + items: *555 examples: - default: *562 + default: *560 headers: Link: *45 x-github: @@ -81308,9 +81002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 requestBody: required: true content: @@ -81345,9 +81039,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *555 examples: - default: *563 + default: *561 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -81375,9 +81069,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: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 - *17 - *19 responses: @@ -81387,7 +81081,7 @@ paths: application/json: schema: type: array - items: *564 + items: *562 examples: default: &674 value: @@ -81926,11 +81620,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 - - &565 + - &563 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)" @@ -81945,7 +81639,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *558 examples: default: &660 value: @@ -82060,11 +81754,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: - - *448 - - *449 + - *444 + - *445 + - *563 + - *564 - *565 - - *566 - - *567 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -82098,9 +81792,9 @@ paths: type: integer check_runs: type: array - items: *512 + items: *508 examples: - default: *568 + default: *566 headers: Link: *45 x-github: @@ -82125,9 +81819,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: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -82135,7 +81829,7 @@ paths: schema: type: integer example: 1 - - *566 + - *564 - *17 - *19 responses: @@ -82153,7 +81847,7 @@ paths: type: integer check_suites: type: array - items: *516 + items: *512 examples: default: value: @@ -82353,9 +82047,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: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - *17 - *19 responses: @@ -82557,9 +82251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *448 - - *449 - - *565 + - *444 + - *445 + - *563 - *17 - *19 responses: @@ -82650,7 +82344,7 @@ paths: site_admin: false headers: Link: *45 - '301': *454 + '301': *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82678,8 +82372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -82712,11 +82406,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *569 + - *567 code_of_conduct_file: anyOf: - type: 'null' - - &570 + - &568 title: Community Health File type: object properties: @@ -82736,19 +82430,19 @@ paths: contributing: anyOf: - type: 'null' - - *570 + - *568 readme: anyOf: - type: 'null' - - *570 + - *568 issue_template: anyOf: - type: 'null' - - *570 + - *568 pull_request_template: anyOf: - type: 'null' - - *570 + - *568 required: - code_of_conduct - code_of_conduct_file @@ -82877,8 +82571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 - name: basehead @@ -82926,8 +82620,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *560 - merge_base_commit: *560 + base_commit: *558 + merge_base_commit: *558 status: type: string enum: @@ -82951,10 +82645,10 @@ paths: - 6 commits: type: array - items: *560 + items: *558 files: type: array - items: *571 + items: *569 required: - url - html_url @@ -83240,8 +82934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -83394,7 +83088,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &572 + response-if-content-is-a-file: &570 summary: Response if content is a file value: type: file @@ -83749,7 +83443,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *572 + response-if-content-is-a-file: *570 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -83818,7 +83512,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *573 + '302': *571 '304': *35 x-github: githubCloudOnly: false @@ -83841,8 +83535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -83937,7 +83631,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &572 title: File Commit description: File Commit type: object @@ -84093,7 +83787,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *572 examples: example-for-creating-a-file: value: @@ -84147,7 +83841,7 @@ paths: schema: oneOf: - *3 - - &615 + - &613 description: Repository rule violation was detected type: object properties: @@ -84200,8 +83894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *448 - - *449 + - *444 + - *445 - name: path description: path parameter in: path @@ -84262,7 +83956,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *572 examples: default: value: @@ -84317,8 +84011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *448 - - *449 + - *444 + - *445 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -84442,8 +84136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *321 - *322 - *323 @@ -84455,7 +84149,7 @@ paths: schema: type: string - *325 - - *575 + - *573 - *326 - *327 - *108 @@ -84476,7 +84170,7 @@ paths: application/json: schema: type: array - items: &579 + items: &577 type: object description: A Dependabot alert. properties: @@ -84526,7 +84220,7 @@ paths: - direct - transitive - - security_advisory: *576 + security_advisory: *574 security_vulnerability: *127 url: *128 html_url: *129 @@ -84557,8 +84251,8 @@ paths: dismissal. maxLength: 280 fixed_at: *133 - auto_dismissed_at: *577 - dismissal_request: *578 + auto_dismissed_at: *575 + dismissal_request: *576 required: - number - state @@ -84788,9 +84482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *448 - - *449 - - &580 + - *444 + - *445 + - &578 name: alert_number in: path description: |- @@ -84805,7 +84499,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *577 examples: default: value: @@ -84918,9 +84612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *448 - - *449 - - *580 + - *444 + - *445 + - *578 requestBody: required: true content: @@ -84965,7 +84659,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *577 examples: default: value: @@ -85094,8 +84788,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -85113,7 +84807,7 @@ paths: type: integer secrets: type: array - items: &583 + items: &581 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -85167,16 +84861,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: *581 + schema: *579 examples: - default: *582 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85196,15 +84890,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '200': description: Response content: application/json: - schema: *583 + schema: *581 examples: default: value: @@ -85230,8 +84924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 requestBody: required: true @@ -85284,8 +84978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *448 - - *449 + - *444 + - *445 - *282 responses: '204': @@ -85308,8 +85002,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: - - *448 - - *449 + - *444 + - *445 - 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 @@ -85483,8 +85177,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -85744,8 +85438,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -85828,7 +85522,7 @@ paths: - version - url additionalProperties: false - metadata: &584 + metadata: &582 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85867,7 +85561,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *584 + metadata: *582 resolved: type: object description: A collection of resolved package dependencies. @@ -85881,7 +85575,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *584 + metadata: *582 relationship: type: string description: A notation of whether a dependency is requested @@ -86014,8 +85708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *448 - - *449 + - *444 + - *445 - name: sha description: The SHA recorded at creation time. in: query @@ -86056,9 +85750,9 @@ paths: application/json: schema: type: array - items: *585 + items: *583 examples: - default: *586 + default: *584 headers: Link: *45 x-github: @@ -86124,8 +85818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -86207,7 +85901,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: simple-example: summary: Simple example @@ -86280,9 +85974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *448 - - *449 - - &587 + - *444 + - *445 + - &585 name: deployment_id description: deployment_id parameter in: path @@ -86294,7 +85988,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *583 examples: default: value: @@ -86359,9 +86053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 responses: '204': description: Response @@ -86383,9 +86077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 - *17 - *19 responses: @@ -86395,7 +86089,7 @@ paths: application/json: schema: type: array - items: &588 + items: &586 title: Deployment Status description: The status of a deployment. type: object @@ -86559,9 +86253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 requestBody: required: true content: @@ -86636,9 +86330,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *586 examples: - default: &589 + default: &587 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -86694,9 +86388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *448 - - *449 - - *587 + - *444 + - *445 + - *585 - name: status_id in: path required: true @@ -86707,9 +86401,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *586 examples: - default: *589 + default: *587 '404': *6 x-github: githubCloudOnly: false @@ -86736,12 +86430,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 + - *588 + - *589 - *590 - *591 - - *592 - - *593 - *17 - *19 responses: @@ -86751,9 +86445,9 @@ paths: application/json: schema: type: array - items: *594 + items: *592 examples: - default: *595 + default: *593 '404': *6 '403': *27 '500': *38 @@ -86777,8 +86471,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86790,7 +86484,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *594 + schema: *592 examples: default: value: @@ -86846,8 +86540,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86906,12 +86600,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 + - *588 + - *589 - *590 - *591 - - *592 - - *593 - *17 - *19 responses: @@ -86921,9 +86615,9 @@ paths: application/json: schema: type: array - items: *596 + items: *594 examples: - default: *597 + default: *595 '404': *6 '403': *27 '500': *38 @@ -86947,8 +86641,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -86960,7 +86654,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *596 + schema: *594 examples: default: value: @@ -87011,8 +86705,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87050,7 +86744,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *596 + schema: *594 examples: default: value: @@ -87101,8 +86795,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87173,8 +86867,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87207,8 +86901,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - *101 - *102 - *103 @@ -87222,9 +86916,9 @@ paths: application/json: schema: type: array - items: *598 + items: *596 examples: - default: *599 + default: *597 '404': *6 '403': *27 '500': *38 @@ -87249,8 +86943,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87262,7 +86956,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *598 + schema: *596 examples: default: value: @@ -87320,8 +87014,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: alert_number in: path required: true @@ -87390,8 +87084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -87448,8 +87142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -87467,7 +87161,7 @@ paths: - 5 environments: type: array - items: &601 + items: &599 title: Environment description: Details of a deployment environment type: object @@ -87529,7 +87223,7 @@ paths: type: string examples: - wait_timer - wait_timer: &603 + wait_timer: &601 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -87571,7 +87265,7 @@ paths: items: type: object properties: - type: *600 + type: *598 reviewer: anyOf: - *4 @@ -87598,7 +87292,7 @@ paths: - id - node_id - type - deployment_branch_policy: &604 + deployment_branch_policy: &602 type: - object - 'null' @@ -87715,9 +87409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *448 - - *449 - - &602 + - *444 + - *445 + - &600 name: environment_name in: path required: true @@ -87730,9 +87424,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *599 examples: - default: &605 + default: &603 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -87816,9 +87510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: false content: @@ -87828,7 +87522,7 @@ paths: - object - 'null' properties: - wait_timer: *603 + wait_timer: *601 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -87847,14 +87541,14 @@ paths: items: type: object properties: - type: *600 + type: *598 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *604 + deployment_branch_policy: *602 additionalProperties: false examples: default: @@ -87874,9 +87568,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *599 examples: - default: *605 + default: *603 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -87900,9 +87594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 responses: '204': description: Default response @@ -87927,9 +87621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *17 - *19 responses: @@ -87948,7 +87642,7 @@ paths: - 2 branch_policies: type: array - items: &606 + items: &604 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -88009,9 +87703,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: true content: @@ -88059,9 +87753,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - example-wildcard: &607 + example-wildcard: &605 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -88103,10 +87797,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - &608 + - *444 + - *445 + - *600 + - &606 name: branch_policy_id in: path required: true @@ -88118,9 +87812,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - default: *607 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88139,10 +87833,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - *608 + - *444 + - *445 + - *600 + - *606 requestBody: required: true content: @@ -88171,9 +87865,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *604 examples: - default: *607 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88192,10 +87886,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *448 - - *449 - - *602 - - *608 + - *444 + - *445 + - *600 + - *606 responses: '204': description: Response @@ -88220,9 +87914,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 responses: '200': description: List of deployment protection rules @@ -88239,7 +87933,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &609 + items: &607 title: Deployment protection rule description: Deployment protection rule type: object @@ -88261,7 +87955,7 @@ paths: for the environment. examples: - true - app: &610 + app: &608 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -88364,9 +88058,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 requestBody: content: application/json: @@ -88387,9 +88081,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *609 + schema: *607 examples: - default: &611 + default: &609 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -88424,9 +88118,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: - - *602 - - *449 - - *448 + - *600 + - *445 + - *444 - *19 - *17 responses: @@ -88446,7 +88140,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *610 + items: *608 examples: default: value: @@ -88481,10 +88175,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: - - *448 - - *449 - - *602 - - &612 + - *444 + - *445 + - *600 + - &610 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -88496,9 +88190,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *607 examples: - default: *611 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88519,10 +88213,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: - - *602 - - *449 - - *448 - - *612 + - *600 + - *445 + - *444 + - *610 responses: '204': description: Response @@ -88548,9 +88242,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *17 - *19 responses: @@ -88568,9 +88262,9 @@ paths: type: integer secrets: type: array - items: *479 + items: *475 examples: - default: *480 + default: *476 headers: Link: *45 x-github: @@ -88595,17 +88289,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 responses: '200': description: Response content: application/json: - schema: *481 + schema: *477 examples: - default: *482 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88627,18 +88321,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 responses: '200': description: Response content: application/json: - schema: *479 + schema: *475 examples: - default: *613 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88660,9 +88354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 requestBody: required: true @@ -88720,9 +88414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *282 responses: '204': @@ -88748,10 +88442,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *448 - - *449 - - *602 - - *466 + - *444 + - *445 + - *600 + - *462 - *19 responses: '200': @@ -88768,9 +88462,9 @@ paths: type: integer variables: type: array - items: *483 + items: *479 examples: - default: *484 + default: *480 headers: Link: *45 x-github: @@ -88793,9 +88487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 requestBody: required: true content: @@ -88847,18 +88541,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *448 - - *449 - - *602 + - *444 + - *445 + - *600 - *285 responses: '200': description: Response content: application/json: - schema: *483 + schema: *479 examples: - default: *614 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88879,10 +88573,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 - - *602 + - *600 requestBody: required: true content: @@ -88924,10 +88618,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *448 - - *449 + - *444 + - *445 - *285 - - *602 + - *600 responses: '204': description: Response @@ -88949,8 +88643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -89018,8 +88712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *448 - - *449 + - *444 + - *445 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -89178,8 +88872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -89212,9 +88906,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 '400': *14 '422': *15 '403': *27 @@ -89235,8 +88929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89296,7 +88990,7 @@ paths: schema: oneOf: - *247 - - *615 + - *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89321,8 +89015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *448 - - *449 + - *444 + - *445 - name: file_sha in: path required: true @@ -89422,8 +89116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89532,7 +89226,7 @@ paths: description: Response content: application/json: - schema: &616 + schema: &614 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -89759,15 +89453,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *448 - - *449 - - *561 + - *444 + - *445 + - *559 responses: '200': description: Response content: application/json: - schema: *616 + schema: *614 examples: default: value: @@ -89823,9 +89517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *448 - - *449 - - &617 + - *444 + - *445 + - &615 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. @@ -89842,7 +89536,7 @@ paths: application/json: schema: type: array - items: &618 + items: &616 title: Git Reference description: Git references within a repository type: object @@ -89918,17 +89612,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: &619 + default: &617 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -89957,8 +89651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -89987,9 +89681,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: *619 + default: *617 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -90015,9 +89709,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 requestBody: required: true content: @@ -90046,9 +89740,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *616 examples: - default: *619 + default: *617 '422': *15 '409': *116 x-github: @@ -90066,9 +89760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *448 - - *449 - - *617 + - *444 + - *445 + - *615 responses: '204': description: Response @@ -90123,8 +89817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -90191,7 +89885,7 @@ paths: description: Response content: application/json: - schema: &621 + schema: &619 title: Git Tag description: Metadata for a Git tag type: object @@ -90247,7 +89941,7 @@ paths: - sha - type - url - verification: *620 + verification: *618 required: - sha - url @@ -90257,7 +89951,7 @@ paths: - tag - message examples: - default: &622 + default: &620 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -90330,8 +90024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *448 - - *449 + - *444 + - *445 - name: tag_sha in: path required: true @@ -90342,9 +90036,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *619 examples: - default: *622 + default: *620 '404': *6 '409': *116 x-github: @@ -90368,8 +90062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -90443,7 +90137,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &621 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -90545,8 +90239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *448 - - *449 + - *444 + - *445 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -90569,7 +90263,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *621 examples: default-response: summary: Default response @@ -90628,8 +90322,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -90639,7 +90333,7 @@ paths: application/json: schema: type: array - items: &624 + items: &622 title: Webhook description: Webhooks for repositories. type: object @@ -90779,8 +90473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -90833,9 +90527,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: &625 + default: &623 value: type: Repository id: 12345678 @@ -90883,17 +90577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '200': description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *625 + default: *623 '404': *6 x-github: githubCloudOnly: false @@ -90913,8 +90607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 requestBody: required: true @@ -90960,9 +90654,9 @@ paths: description: Response content: application/json: - schema: *624 + schema: *622 examples: - default: *625 + default: *623 '422': *15 '404': *6 x-github: @@ -90983,8 +90677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91009,8 +90703,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: - - *448 - - *449 + - *444 + - *445 - *335 responses: '200': @@ -91038,8 +90732,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: - - *448 - - *449 + - *444 + - *445 - *335 requestBody: required: false @@ -91084,8 +90778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 - *17 - *336 @@ -91117,8 +90811,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: - - *448 - - *449 + - *444 + - *445 - *335 - *16 responses: @@ -91147,8 +90841,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: - - *448 - - *449 + - *444 + - *445 - *335 - *16 responses: @@ -91172,8 +90866,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91199,8 +90893,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *448 - - *449 + - *444 + - *445 - *335 responses: '204': @@ -91224,8 +90918,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response if immutable releases are enabled @@ -91273,8 +90967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '409': *116 @@ -91294,8 +90988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '409': *116 @@ -91352,14 +91046,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response content: application/json: - schema: &626 + schema: &624 title: Import description: A repository import from an external source. type: object @@ -91466,7 +91160,7 @@ paths: - html_url - authors_url examples: - default: &629 + default: &627 value: vcs: subversion use_lfs: true @@ -91482,7 +91176,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': &627 + '503': &625 description: Unavailable due to service under maintenance. content: application/json: @@ -91511,8 +91205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -91560,7 +91254,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: default: value: @@ -91585,7 +91279,7 @@ paths: type: string '422': *15 '404': *6 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91613,8 +91307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -91666,7 +91360,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: example-1: summary: Example 1 @@ -91714,7 +91408,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': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91737,12 +91431,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91768,8 +91462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *448 - - *449 + - *444 + - *445 - &809 name: since description: A user ID. Only return users with an ID greater than this ID. @@ -91784,7 +91478,7 @@ paths: application/json: schema: type: array - items: &628 + items: &626 title: Porter Author description: Porter Author type: object @@ -91838,7 +91532,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': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91863,8 +91557,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *448 - - *449 + - *444 + - *445 - name: author_id in: path required: true @@ -91894,7 +91588,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *626 examples: default: value: @@ -91907,7 +91601,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91931,8 +91625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -91973,7 +91667,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92001,8 +91695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -92029,11 +91723,11 @@ paths: description: Response content: application/json: - schema: *626 + schema: *624 examples: - default: *629 + default: *627 '422': *15 - '503': *627 + '503': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92056,8 +91750,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -92065,8 +91759,8 @@ paths: application/json: schema: *20 examples: - default: *630 - '301': *454 + default: *628 + '301': *450 '404': *6 x-github: githubCloudOnly: false @@ -92086,8 +91780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -92100,7 +91794,7 @@ paths: properties: {} additionalProperties: false examples: - default: &632 + default: &630 value: limit: collaborators_only origin: repository @@ -92125,13 +91819,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: application/json: - schema: *631 + schema: *629 examples: default: summary: Example request body @@ -92145,7 +91839,7 @@ paths: application/json: schema: *353 examples: - default: *632 + default: *630 '409': description: Response x-github: @@ -92167,8 +91861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -92191,8 +91885,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -92202,7 +91896,7 @@ paths: application/json: schema: type: array - items: *633 + items: *631 examples: default: &802 value: @@ -92335,8 +92029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *448 - - *449 + - *444 + - *445 - *357 requestBody: required: false @@ -92366,7 +92060,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *631 examples: default: value: @@ -92497,8 +92191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *448 - - *449 + - *444 + - *445 - *357 responses: '204': @@ -92530,8 +92224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *448 - - *449 + - *444 + - *445 - 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 @@ -92752,7 +92446,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *454 + '301': *450 '422': *15 '404': *6 x-github: @@ -92781,8 +92475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -93030,7 +92724,7 @@ paths: '422': *15 '503': *189 '404': *6 - '410': *634 + '410': *632 x-github: triggersNotification: true githubCloudOnly: false @@ -93058,8 +92752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *235 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -93080,7 +92774,7 @@ paths: application/json: schema: type: array - items: *635 + items: *633 examples: default: &640 value: @@ -93140,17 +92834,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: &636 + default: &634 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -93204,8 +92898,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -93228,9 +92922,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: *636 + default: *634 '422': *15 x-github: githubCloudOnly: false @@ -93248,8 +92942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -93270,8 +92964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -93298,9 +92992,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -93321,8 +93015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -93355,16 +93049,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -93386,10 +93080,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - *636 responses: '204': description: Response @@ -93409,8 +93103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -93759,8 +93453,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *448 - - *449 + - *444 + - *445 - name: event_id in: path required: true @@ -93963,7 +93657,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *634 + '410': *632 '403': *27 x-github: githubCloudOnly: false @@ -93997,8 +93691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - &639 name: issue_number description: The number that identifies the issue. @@ -94014,9 +93708,9 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '304': *35 x-github: githubCloudOnly: false @@ -94041,8 +93735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -94168,9 +93862,9 @@ paths: '422': *15 '503': *189 '403': *27 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94188,8 +93882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -94234,8 +93928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: content: @@ -94285,8 +93979,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: - - *448 - - *449 + - *444 + - *445 - *639 - name: assignee in: path @@ -94327,8 +94021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *218 - *17 @@ -94340,13 +94034,13 @@ paths: application/json: schema: type: array - items: *635 + items: *633 examples: default: *640 headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94375,8 +94069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -94399,16 +94093,16 @@ paths: description: Response content: application/json: - schema: *635 + schema: *633 examples: - default: *636 + default: *634 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -94436,8 +94130,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: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -94453,9 +94147,9 @@ paths: default: *641 headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94483,8 +94177,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: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -94515,9 +94209,9 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *454 + '301': *450 '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -94548,8 +94242,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: - - *448 - - *449 + - *444 + - *445 - *639 - name: issue_id in: path @@ -94565,12 +94259,12 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *634 + '410': *632 x-github: triggersNotification: true githubCloudOnly: false @@ -94596,8 +94290,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: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -94613,9 +94307,9 @@ paths: default: *641 headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94632,8 +94326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -95427,7 +95121,7 @@ paths: color: red headers: Link: *45 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95444,8 +95138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -95476,9 +95170,9 @@ paths: default: false headers: Link: *45 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95495,8 +95189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95559,9 +95253,9 @@ paths: items: *211 examples: default: *642 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '422': *15 x-github: githubCloudOnly: false @@ -95578,8 +95272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95643,9 +95337,9 @@ paths: items: *211 examples: default: *642 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 '422': *15 x-github: githubCloudOnly: false @@ -95662,15 +95356,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '204': description: Response - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95689,8 +95383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - name: name in: path @@ -95715,9 +95409,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95737,8 +95431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: false @@ -95768,7 +95462,7 @@ paths: '204': description: Response '403': *27 - '410': *634 + '410': *632 '404': *6 '422': *15 x-github: @@ -95786,8 +95480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '204': @@ -95818,8 +95512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 responses: '200': @@ -95829,9 +95523,9 @@ paths: schema: *212 examples: default: *638 - '301': *454 + '301': *450 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95848,8 +95542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -95876,13 +95570,13 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95900,8 +95594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -95934,16 +95628,16 @@ paths: description: Response content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Response content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -95965,10 +95659,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *639 - - *442 + - *636 responses: '204': description: Response @@ -95997,8 +95691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96056,8 +95750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -96074,7 +95768,7 @@ paths: headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96102,8 +95796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96140,7 +95834,7 @@ paths: schema: type: string '403': *27 - '410': *634 + '410': *632 '422': *15 '404': *6 x-github: @@ -96160,8 +95854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 requestBody: required: true @@ -96217,8 +95911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *448 - - *449 + - *444 + - *445 - *639 - *17 - *19 @@ -96813,7 +96507,7 @@ paths: type: string comments: type: array - items: *559 + items: *555 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -97088,7 +96782,7 @@ paths: headers: Link: *45 '404': *6 - '410': *634 + '410': *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97105,8 +96799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -97184,8 +96878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97257,8 +96951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 - &658 name: key_id description: The unique identifier of the key. @@ -97291,8 +96985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *448 - - *449 + - *444 + - *445 - *658 responses: '204': @@ -97313,8 +97007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -97347,8 +97041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97418,8 +97112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97449,8 +97143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97515,8 +97209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *448 - - *449 + - *444 + - *445 - name: name in: path required: true @@ -97542,8 +97236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -97579,8 +97273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '202': *37 '403': @@ -97608,8 +97302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -97635,9 +97329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *448 - - *449 - - *534 + - *444 + - *445 + - *530 responses: '200': description: Response @@ -97784,8 +97478,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97850,8 +97544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -97885,7 +97579,7 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *560 + schema: *558 examples: default: *660 '204': @@ -97912,8 +97606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *448 - - *449 + - *444 + - *445 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -98010,8 +97704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98112,8 +97806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - &662 name: milestone_number description: The number that identifies the milestone. @@ -98145,8 +97839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - *662 requestBody: required: false @@ -98203,8 +97897,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *448 - - *449 + - *444 + - *445 - *662 responses: '204': @@ -98226,8 +97920,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: - - *448 - - *449 + - *444 + - *445 - *662 - *17 - *19 @@ -98259,8 +97953,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: - - *448 - - *449 + - *444 + - *445 - *663 - *664 - *218 @@ -98300,8 +97994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -98359,8 +98053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -98551,8 +98245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98632,8 +98326,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -98741,8 +98435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -98768,8 +98462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -98871,8 +98565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *448 - - *449 + - *444 + - *445 responses: '201': description: Response @@ -98919,8 +98613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -98976,8 +98670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *448 - - *449 + - *444 + - *445 - name: build_id in: path required: true @@ -99010,8 +98704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -99119,8 +98813,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: - - *448 - - *449 + - *444 + - *445 - &671 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit @@ -99179,8 +98873,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *448 - - *449 + - *444 + - *445 - *671 responses: '204': *148 @@ -99208,8 +98902,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -99504,8 +99198,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Private vulnerability reporting status @@ -99542,8 +99236,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: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '422': *14 @@ -99564,8 +99258,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: - - *448 - - *449 + - *444 + - *445 responses: '204': *148 '422': *14 @@ -99587,8 +99281,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -99620,8 +99314,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -99675,8 +99369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *448 - - *449 + - *444 + - *445 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -99736,7 +99430,7 @@ paths: application/json: schema: type: array - items: *564 + items: *562 examples: default: *674 headers: @@ -99770,8 +99464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -100707,8 +100401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *448 - - *449 + - *444 + - *445 - name: sort in: query required: false @@ -100816,8 +100510,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: - - *448 - - *449 + - *444 + - *445 - *227 responses: '200': @@ -100901,8 +100595,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: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -100943,8 +100637,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: - - *448 - - *449 + - *444 + - *445 - *227 responses: '204': @@ -100966,8 +100660,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: - - *448 - - *449 + - *444 + - *445 - *227 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -100994,9 +100688,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -101017,8 +100711,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: - - *448 - - *449 + - *444 + - *445 - *227 requestBody: required: true @@ -101051,16 +100745,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -101082,10 +100776,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *227 - - *442 + - *636 responses: '204': description: Response @@ -101128,8 +100822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - &680 name: pull_number description: The number that identifies the pull request. @@ -101180,8 +100874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -101248,8 +100942,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -101313,7 +101007,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -101321,7 +101015,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -101351,8 +101045,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: - - *448 - - *449 + - *444 + - *445 - *680 - *235 - name: direction @@ -101409,8 +101103,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -101605,8 +101299,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: - - *448 - - *449 + - *444 + - *445 - *680 - *227 requestBody: @@ -101716,8 +101410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -101728,7 +101422,7 @@ paths: application/json: schema: type: array - items: *560 + items: *558 examples: default: *682 headers: @@ -101760,8 +101454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -101772,7 +101466,7 @@ paths: application/json: schema: type: array - items: *571 + items: *569 examples: default: value: @@ -101810,8 +101504,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: - - *448 - - *449 + - *444 + - *445 - *680 responses: '204': @@ -101835,8 +101529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -101949,8 +101643,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: - - *448 - - *449 + - *444 + - *445 - *680 responses: '200': @@ -102026,8 +101720,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -102065,7 +101759,7 @@ paths: description: Response content: application/json: - schema: *564 + schema: *562 examples: default: value: @@ -102601,8 +102295,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: true @@ -102637,7 +102331,7 @@ paths: description: Response content: application/json: - schema: *564 + schema: *562 examples: default: value: @@ -103142,8 +102836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *448 - - *449 + - *444 + - *445 - *680 - *17 - *19 @@ -103310,8 +103004,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: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -103467,8 +103161,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: - - *448 - - *449 + - *444 + - *445 - *680 - &684 name: review_id @@ -103543,8 +103237,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -103631,8 +103325,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 responses: @@ -103669,8 +103363,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 - *17 @@ -103930,8 +103624,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -104025,8 +103719,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: - - *448 - - *449 + - *444 + - *445 - *680 - *684 requestBody: @@ -104087,8 +103781,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *448 - - *449 + - *444 + - *445 - *680 requestBody: required: false @@ -104153,8 +103847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *448 - - *449 + - *444 + - *445 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -104211,8 +103905,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: - - *448 - - *449 + - *444 + - *445 - name: dir description: The alternate path to look for a README file in: path @@ -104256,8 +103950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -104361,8 +104055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -104545,8 +104239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - &691 name: asset_id description: The unique identifier of the asset. @@ -104596,7 +104290,7 @@ paths: type: User site_admin: false '404': *6 - '302': *573 + '302': *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104612,8 +104306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - *691 requestBody: required: false @@ -104661,8 +104355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *448 - - *449 + - *444 + - *445 - *691 responses: '204': @@ -104687,8 +104381,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -104774,8 +104468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -104800,8 +104494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *448 - - *449 + - *444 + - *445 - name: tag description: tag parameter in: path @@ -104838,8 +104532,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *448 - - *449 + - *444 + - *445 - &694 name: release_id description: The unique identifier of the release. @@ -104874,8 +104568,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 requestBody: required: false @@ -104963,8 +104657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 responses: '204': @@ -104985,8 +104679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *448 - - *449 + - *444 + - *445 - *694 - *17 - *19 @@ -105079,8 +104773,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: - - *448 - - *449 + - *444 + - *445 - *694 - name: name in: query @@ -105162,8 +104856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -105188,9 +104882,9 @@ paths: application/json: schema: type: array - items: *439 + items: *556 examples: - default: *441 + default: *635 headers: Link: *45 '404': *6 @@ -105211,8 +104905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *448 - - *449 + - *444 + - *445 - *694 requestBody: required: true @@ -105243,16 +104937,16 @@ paths: description: Reaction exists content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '201': description: Reaction created content: application/json: - schema: *439 + schema: *556 examples: - default: *440 + default: *557 '422': *15 x-github: githubCloudOnly: false @@ -105274,10 +104968,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *448 - - *449 + - *444 + - *445 - *694 - - *442 + - *636 responses: '204': description: Response @@ -105301,9 +104995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *448 - - *449 - - *501 + - *444 + - *445 + - *497 - *17 - *19 responses: @@ -105440,8 +105134,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - name: includes_parents @@ -105507,8 +105201,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 requestBody: description: Request body required: true @@ -105617,8 +105311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *448 - - *449 + - *444 + - *445 - *699 - *103 - *700 @@ -105653,8 +105347,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *448 - - *449 + - *444 + - *445 - *704 responses: '200': @@ -105691,8 +105385,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105732,8 +105426,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105815,8 +105509,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105839,8 +105533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 - name: ruleset_id @@ -105877,8 +105571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *448 - - *449 + - *444 + - *445 - name: ruleset_id description: The ID of the ruleset. in: path @@ -105951,8 +105645,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: - - *448 - - *449 + - *444 + - *445 - *410 - *411 - *412 @@ -106230,9 +105924,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *418 responses: '200': @@ -106293,9 +105987,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 requestBody: required: true content: @@ -106435,9 +106129,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: - - *448 - - *449 - - *528 + - *444 + - *445 + - *524 - *19 - *17 responses: @@ -106573,8 +106267,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -106653,8 +106347,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: - - *448 - - *449 + - *444 + - *445 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -106775,8 +106469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *448 - - *449 + - *444 + - *445 - *108 - name: sort description: The property to sort the results by. @@ -106845,8 +106539,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -107251,8 +106945,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -107512,8 +107206,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '200': @@ -107546,8 +107240,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: - - *448 - - *449 + - *444 + - *445 - *732 requestBody: required: true @@ -107760,8 +107454,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '202': *37 @@ -107789,17 +107483,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: - - *448 - - *449 + - *444 + - *445 - *732 responses: '202': description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 '400': *14 '422': *15 '403': *27 @@ -107825,8 +107519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -107922,8 +107616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -107965,8 +107659,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108044,8 +107738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108139,8 +107833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -108294,8 +107988,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -108338,8 +108032,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *448 - - *449 + - *444 + - *445 - name: sha in: path required: true @@ -108449,8 +108143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108482,8 +108176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: if you subscribe to the repository @@ -108562,8 +108256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -108616,8 +108310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -108637,8 +108331,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108720,8 +108414,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: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -108786,8 +108480,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: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -108841,8 +108535,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: - - *448 - - *449 + - *444 + - *445 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -108879,8 +108573,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *448 - - *449 + - *444 + - *445 - name: ref in: path required: true @@ -108916,8 +108610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *448 - - *449 + - *444 + - *445 - *17 - *19 responses: @@ -108949,8 +108643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *448 - - *449 + - *444 + - *445 - *19 - *17 responses: @@ -108993,8 +108687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -109048,8 +108742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *448 - - *449 + - *444 + - *445 - &740 name: per description: The time frame to display results for. @@ -109169,8 +108863,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -109265,8 +108959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *448 - - *449 + - *444 + - *445 responses: '200': description: Response @@ -109330,8 +109024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *448 - - *449 + - *444 + - *445 - *740 responses: '200': @@ -109431,8 +109125,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *448 - - *449 + - *444 + - *445 requestBody: required: true content: @@ -109706,8 +109400,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -109730,8 +109424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -109753,8 +109447,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -109780,8 +109474,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *448 - - *449 + - *444 + - *445 - name: ref in: path required: true @@ -109873,9 +109567,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -112427,7 +112121,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 comment_count: type: integer message: @@ -112446,7 +112140,7 @@ paths: url: type: string format: uri - verification: *620 + verification: *618 required: - author - committer @@ -112461,7 +112155,7 @@ paths: committer: anyOf: - type: 'null' - - *499 + - *495 parents: type: array items: @@ -114675,246 +114369,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: - - *773 - - *435 - - *438 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *773 - - *435 - - *438 - 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: *439 - examples: - default: *440 - 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: - - *773 - - *435 - - 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: *439 - examples: - default: *441 - headers: - Link: *45 - 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: - - *773 - - *435 - 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: *439 - examples: - default: *440 - 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) @@ -115140,7 +114594,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-user-is-a-team-maintainer: *778 '404': *6 @@ -115201,7 +114655,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *443 examples: response-if-users-membership-with-team-is-now-pending: *779 '403': @@ -115308,8 +114762,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 responses: '200': description: Alternative response with extra repository information @@ -115467,8 +114921,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 requestBody: required: false content: @@ -115519,8 +114973,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - *773 - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -115555,9 +115009,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: - default: *451 + default: *447 '403': *27 '404': *6 x-github: @@ -115645,7 +115099,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *446 examples: default: value: @@ -116477,7 +115931,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -116485,7 +115939,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -116571,7 +116025,7 @@ paths: - visibility - selected_repositories_url examples: - default: *553 + default: *549 headers: Link: *45 x-github: @@ -116947,7 +116401,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '304': *35 '500': *38 '401': *23 @@ -117005,7 +116459,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '401': *23 '403': *27 '404': *6 @@ -117199,7 +116653,7 @@ paths: type: integer machines: type: array - items: *552 + items: *548 examples: default: *788 '304': *35 @@ -117286,11 +116740,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *453 + repository: *449 machine: anyOf: - type: 'null' - - *552 + - *548 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -118095,7 +117549,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '304': *35 '500': *38 '400': *14 @@ -118135,7 +117589,7 @@ paths: application/json: schema: *363 examples: - default: *551 + default: *547 '500': *38 '401': *23 '403': *27 @@ -119306,7 +118760,7 @@ paths: required: true content: application/json: - schema: *631 + schema: *629 examples: default: value: @@ -121771,9 +121225,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *449 examples: - default: *455 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -121811,7 +121265,7 @@ paths: application/json: schema: type: array - items: *633 + items: *631 examples: default: *802 headers: @@ -122430,8 +121884,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response if this repository is starred by you @@ -122459,8 +121913,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -122484,8 +121938,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: - - *448 - - *449 + - *444 + - *445 responses: '204': description: Response @@ -123166,7 +122620,7 @@ paths: initiator: type: string examples: - default: *495 + default: *491 '201': description: Response content: @@ -123697,7 +123151,7 @@ paths: application/json: schema: *20 examples: - default: *630 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -131573,7 +131027,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131905,7 +131359,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132249,7 +131703,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132608,7 +132062,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132891,7 +132345,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133189,7 +132643,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -133510,7 +132964,7 @@ webhooks: required: - login - id - dismissed_comment: *523 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -134622,7 +134076,7 @@ webhooks: type: string enum: - auto_dismissed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134710,7 +134164,7 @@ webhooks: type: string enum: - auto_reopened - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134798,7 +134252,7 @@ webhooks: type: string enum: - created - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134884,7 +134338,7 @@ webhooks: type: string enum: - dismissed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -134970,7 +134424,7 @@ webhooks: type: string enum: - fixed - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -135057,7 +134511,7 @@ webhooks: type: string enum: - reintroduced - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -135143,7 +134597,7 @@ webhooks: type: string enum: - reopened - alert: *579 + alert: *577 installation: *833 organization: *834 enterprise: *832 @@ -136661,7 +136115,7 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *585 + deployment: *583 pull_requests: type: array items: *678 @@ -168055,7 +167509,7 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *515 + head_commit: *511 required: - head_sha - head_ref @@ -242539,7 +241993,7 @@ webhooks: enterprise: *832 installation: *833 organization: *834 - repository: *453 + repository: *449 sender: *4 required: - changes @@ -247869,7 +247323,7 @@ webhooks: type: string required: - conclusion - deployment: *585 + deployment: *583 required: - action - repository @@ -248233,7 +247687,7 @@ webhooks: required: - status - steps - deployment: *585 + deployment: *583 required: - action - repository @@ -248461,7 +247915,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *585 + deployment: *583 required: - action - repository @@ -248690,7 +248144,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *585 + deployment: *583 required: - action - repository diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index ffb02c980..ad7a8da99 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -41349,449 +41349,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", @@ -81640,338 +81197,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)", @@ -144494,66 +143719,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -150897,6 +150062,66 @@ "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -324495,177 +323720,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, @@ -324679,7 +323751,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -324701,19 +323773,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, @@ -324726,7 +323803,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -324748,19 +323825,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, @@ -324773,12 +323855,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -324798,16 +323878,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=", @@ -324827,8 +323926,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": { @@ -330210,6 +329377,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": [ { @@ -346692,15 +345917,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", @@ -347020,6 +346236,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-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index e9d2267b5..5f3ac1b3f 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -29799,326 +29799,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 @@ -59021,256 +58701,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) @@ -104693,49 +104123,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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -109347,6 +108734,49 @@ 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -239703,56 +239133,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: @@ -244379,6 +243759,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 @@ -258577,13 +258007,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 @@ -258858,6 +258281,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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index ffb02c980..ad7a8da99 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -41349,449 +41349,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", @@ -81640,338 +81197,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)", @@ -144494,66 +143719,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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, "team-membership": { "title": "Team Membership", "description": "Team Membership", @@ -150897,6 +150062,66 @@ "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, "branch-short": { "title": "Branch Short", "description": "Branch Short", @@ -324495,177 +323720,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, @@ -324679,7 +323751,7 @@ } ] }, - "team-discussion-comment": { + "team-discussion": { "value": { "author": { "login": "octocat", @@ -324701,19 +323773,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, @@ -324726,7 +323803,7 @@ } } }, - "team-discussion-comment-2": { + "team-discussion-2": { "value": { "author": { "login": "octocat", @@ -324748,19 +323825,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, @@ -324773,12 +323855,10 @@ } } }, - "reaction-items": { + "team-discussion-comment-items": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -324798,16 +323878,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=", @@ -324827,8 +323926,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": { @@ -330210,6 +329377,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": [ { @@ -346692,15 +345917,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", @@ -347020,6 +346236,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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index e9d2267b5..5f3ac1b3f 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -29799,326 +29799,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 @@ -59021,256 +58701,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) @@ -104693,49 +104123,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 - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -109347,6 +108734,49 @@ 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at branch-short: title: Branch Short description: Branch Short @@ -239703,56 +239133,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: @@ -244379,6 +243759,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 @@ -258577,13 +258007,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 @@ -258858,6 +258281,13 @@ co{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}